Doxygenコメント規約
極力@xxxを使用せずともわかる方がよい
ファイルヘッダ
~~~ /*!
Copyright
*
*/
~~~
関数ヘッダ
~~~
/*!
get_ret
*
@param[in] varname 説明
@return 結果の数 */
~~~
クラスヘッダ
~~~ /*!
ファイルコメント参照。
*
ファイルコメント参照。 */
~~~
構造体
~~~ /*!
It's a struct. */
~~~
グローバル変数
~~~ /*!
@var global_var1
グローバル変数の説明 */
~~~
列挙型
~~~ /*!
列挙型の説明 */
~~~
コメント
ページヘッダ
~~~
/*! @mainpage planchkproc
*
@section 概要
*
S02015用中継器設定情報ファイルフォーマットチェックツール
*
@section 詳細
フォーマットをチェックする
*
@subsection 背景
S02015で受け取る中継器設定情報ファイルがでたらめである可能性が発生したため
*
*/
~~~
Last updated