読者です 読者をやめる 読者になる 読者になる

by shigemk2

当面は技術的なことしか書かない

Doxygenのコメント(関数)

Doxygen

◆◆電八開発倶楽部◆◆

/*!
 @brief 説明要約。関数の詳しい説明。
 @attention 注意。現在の仕様で、使用時に他の説明から判断できない注意点。
 @warning 警告。開発者向けに動作仕様からは判らない重要な注意事項があれば書く。
 @note 覚え書き。開発中に参照するためのメモ。
 @sa see also

 @param [in] 引数。@paramは引数を採り、フォーマットされるので、引数名と説明を : で区切ったりしてはいけない。ソース上の整形として、改行・空白(半角スペースとタブ)文字による桁揃えはしてよい。
 @return 戻り値の説明。無いときはなるべく「なし」と書くべき。BOOL値やエラーコードなど値が何種類か決まっている場合には以下のように続けて@retvalで列挙します。
 @retval 戻り値の例 とその意味。種類の数だけ列挙する。

 */

@autherとか@dateは、gitとか使っているのなら必要ないのではないかな?とも思う。
安易に@warningとかを使うのもよくない気はする。