Doxygen5(ファイルと関数のコメント)

・目次

1.目的
2.コメントの付け方
3.Doxygenでドキュメント作成確認(コメント)
4.Doxygenでドキュメント作成確認(実際に使用して作成した場合)
関連記事

1.目的

　・Javadocで使用されるコメントの書き方について記載する。

　・コメントを記載した場合、Doxygenでどのように出力されるのか確認する。

　　参考：Doxygen(コメント)

2.コメントの付け方

　・JAVADOCには、それぞれコメントの種類によって、タグが用意されている。

　・ここでは、下記3.Doxygenでドキュメント作成確認にて、それぞれのタグと、その意味、その結果としてDoxygenで作成した場合の出力結果を示している。

　・Doxygenの設定に関しては下記ブログを参照

　→Doxygen4(DoxygenでGraphwizを使用) - Project_OKI’s diary

3.Doxygenでドキュメント作成確認(コメント)

/** *********************************************** */
/**
 *	@file		main.c
 *	@brief		概要
 *	@date		日付
 *	@version	バージョン
 *	@author		作成者
 *	@since		過去のバージョン
 */
/** *********************************************** */

#include <stdio.h>

/**
 * @brief 		概要
 * @param		引数
 * @param[in] 	　　　　 引数(入力)
 * @param[out]  	引数(出力)
* @param[in,out]	引数(入出力)
 * @return 		戻り値
 * @retval		戻り値(複数)
 * @note		メモ
 * @attention   	この関数を呼び出す際の注意点
 * @throw		エラーになる条件
 * @pre			事前条件
 */
void Get() {
    printf("void");	///<出力
}

/**
 * @brief メイン関数
 * @param　void	:None
 * @return  int	:プログラムの終了コード
 */
int main() {
	Get();			///関数を実行
    return 0;
}

---JAVADOC出力結果---

4.Doxygenでドキュメント作成確認(実際に使用して作成した場合)

/** *********************************************** */
/**
 *	@file		main.c
 *	@brief		メイン処理
 *	@brief		Compiler: CubeIDE
 *	@brief		CPU: STM32F401RE
 *	@date		2024/10/01
 *	@version	1.00 
 *	@author		OKI 
 */
/** *********************************************** */

#include <stdio.h>

/**
 * @brief 2つの整数を加算する
 * @param 		int a 	:1つ目の整数
 * @param 		int b 	:2つ目の整数
 * @return 		int	:加算結果
 * @note		int型以上の値だとエラーになる。
 * @attention	なし
 */
int add(int a, int b) {
	return(a + b);	///<引数a+bの結果を返す。
}

/**
 * @brief 計算を実行し結果を表示する
 * @param 	int	x	:1つ目の整数
 * @param 	int	y	:2つ目の整数
 * @return 	void	:None
 */
void calculate(int x, int y) {
    int sum = add(x, y);		///<add関数実行
    printf("%d+%d = %d\n",x,y,sum);	///<計算結果の出力
}

/**
 * @brief 計算を実行し結果を表示する
 * @param 	void	:None
 * @return 	void	:None
 */
void Get() {
    printf("void");	///<計算結果の出力
}


/**
 * @brief メイン関数
 * @param	void	:None
 * @return  int		:プログラムの終了コード
 */
int main() {
	Get();
    calculate(5, 3);				///<計算の実行
    return 0;
}