![]()
・目次
1.目的
・DoxygenはソースファイルからJavadocに則ったコメントを使用することにより、ドキュメントの作成が出来る。
・Doxygenのインストールとドキュメント作成プロセスについて説明する。
マニュアル：Doxygen
2.Doxygenのダウンロード
・Doxygenのダウンロード
上記公式ホームページのダウンロードから、Doxygenのダウンロードが出来る。
(Doxygenのダウンロードページ：Doxygen download)
・上記サイトから、自分の環境に合わせてダウンロードするファイルを選択
・.exeファイルを実行し、doxygenをダウンロードする。
・下記アイコンのようなDoxywizardという名前のアプリとなる。
3.Doxygenでドキュメント作成
・今回は下記コードをサンプルとして、ソースコードを用意し、
ドキュメントの作成を行う。
・今回は、下記ソースをサンプルとして使用する。
doxygen出力設定
(1) doxygenのbinファイル、出力対象ファイル、出力場所の設定
※Nextを押し、次へ移動
(2)出力ドキュメントの種類及び、出力ソースコードの種類を設定
※Runを押し、次へ移動
(3)ドキュメントの作成
4.Doxygenの書き方
・doxygenはタグを使用して、説明を作成する。
・作成方法
/** */で下記タグを覆う * @file ファイル名、ファイルの説明 * @brief 短い説明 * @date 日付 * @version バージョン情報 * @author プログラム、ドキュメントの作者名 * @param パラメータ(関数の引数等) * @return返り値
/** * @version バージョン情報*/
例：
/** * @file main.c * @brief メイン処理 * @brief Compiler : CubeIDE * @brief CPU : STM32F401RE * @date $LastChangedDate : 2024/06/29$ * @version $Revision : 1.00 $ * @author $LastChangedBy : OKI $ */
や
/** * set出力関数 * @param void : None * @return void : None */
・区切りの作成
/** *********************************************** */
5.Doxygenでドキュメント作成ファイル確認
下記コードをdoxygenで出力
・index.mdファイル
# Doxygen確認プログラム {#mainpage}
## doxygen導入1{#sec1}
* これはmarkdown形式での書き方です。
* doxygenで使用できるコマンドと出力について確認する。
* メインページ(.md)ファイルの作成と、main.cファイルを作成し、その出力を確認する。
・main.cファイル
/** *********************************************** *//** * @file main.c * @brief メイン処理 * @brief Compiler : CubeIDE * @brief CPU : STM32F401RE * @date $LastChangedDate : 2024/06/29$ * @version $Revision : 1.00 $ * @author $LastChangedBy : OKI $ *//** *********************************************** */#include "stdio.h"/** *********************************************** *//** * set出力関数 * @param void : None * @return void : None *//** *********************************************** */voidsetprint(){ ///出力実行printf("set"); ///< set出力printf("test"); ///< test出力 } /************************************************* *//** * メイン関数 * @param void : None * @return void : None *//************************************************ */intmain(){ setprint(); ///< 文字列の表示 }
ーーーーーーーーーーーー
出力結果
Main Pgeのページ
Filesのページ
main.cのページ
ーーーーーーーーーーーー
.mdファイルの説明
・本ファイルはマークダウン形式で作成している。
・# Doxygen確認プログラム {#mainpage} ：mainpageによって、Main Pageを指定
・## doxygen導入1{#sec1} ：セクションを作成
・ * ：1行
.cファイルの説明
・doxygenの上記例を元に作成した結果を表示している。
・/// で関数内のコメントを作成
ここでは///は、全体の動作説明、///<は、その行の説明にしている。
参考：
・Doxygen(リストの作成方法)
・Doxygen(コメント付け方)
・ドキュメンテーションコメントからプログラミングを考える / 『エンジニアのためのJavadoc再入門講座』を読んだ - こまぶろ