Javadocのコメントについて
・目次
1.目的
・Javadocで使用されるコメントの書き方について記載する。
・コメントを記載した場合、Doxygenでどのように出力されるのか確認する。
参考：Doxygen(コメント)
2.コメントの付け方
C スタイルのコメント
/** * ... コメント ... */
Qt スタイルのコメント
/*! * ... コメント ... */
追加のスラッシュ又は感嘆符で始まるコメント
/// /// ... コメント出力 ... ///
追加のスラッシュ又は感嘆符で始まるコメント2
//! //!... コメント出力2... //!
目立つコメント
/********************************************//** * ... 目立つコメント ***********************************************/
目立つコメント2
///////////////////////////////////////////////// /// ... 目立つコメント2 ... /////////////////////////////////////////////////
3.Doxygenでドキュメント作成確認(コメント)
/** *********************************************** */ /** * @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 */ /** *********************************************** */ void setprint(){ ///出力実行 //コメント・ブロックに詳細説明のマークを付ける /** * ... set出力(Cスタイル) ... * ... 確認 ... */ printf("set"); ///< set出力 /*! * ... test出力(Qtスタイル) ... * ... 確認 ... */ printf("test"); ///< test出力 /// /// ... コメント出力 ... /// ... 確認 ... /// printf(" コメント出力"); ///< コメント出力 //! //!... コメント出力2... //! ... 確認 ... //! printf(" コメント出力2"); ///< コメント出力 /********************************************//** * ... 目立つコメント * ... 確認 ***********************************************/ printf(" 目立つコメント"); ///< 目立つコメント出力 ///////////////////////////////////////////////// /// ... 目立つコメント2 ... /// ... 確認 ... ///////////////////////////////////////////////// printf(" 目立つコメント2"); ///< 目立つコメント出力 } /************************************************* */ /** * メイン関数 * @param void : None * @return void : None */ /************************************************ */ int main(){ setprint(); ///< 文字列の表示 }
ーーーーーーーーーーー
作成結果(setprint関数の所のみ)
・下記画像より、どのコメント形式で書いても出力結果は変わらなかった。
参考：
・Doxygen(リストの作成方法)
・Doxygen(コメント付け方)
・ドキュメンテーションコメントからプログラミングを考える / 『エンジニアのためのJavadoc再入門講座』を読んだ - こまぶろ
関連記事
