まくろぐ

Doxygen のコメントの書き方: TODO コメント

更新:
作成:

関数のコメントとして、以下のように @todo タグを入れておくと、 ドキュメント内の Member Function Documentation の節で、TODO リストとして表示されるようになります。

ヘッダファイルではなく、CPP ファイル内にインラインコメントとして @todo を含めることもできます。 この場合は、ヘッダファイル内の関数コメントとして有効な Doxygen コメントを記述しておく必要があります。

/**
 * @brief Brief description.
 * @todo Modify macros.
 */
void Hoge();

void MyClass::Hoge() {
     /// @todo Modify macro name.
     TEMPORARY_MACRO();
}

関連記事

まくろぐ
サイトマップまくへのメッセージ