comments - マルチブレット Doxygen @note?

Question

Doxygen 以外のコメントでは、次のことがよくあります。

/* Lorem ipsum etc.
 *
 * Notes:
 * - A first note.
 * - Some other note note.
 */

しかし、Doxygen では@note(または\note) ではなく@notes) があります。では、複数@noteの を使用する必要がありますか、それともすべてのメモを同じ の下に配置する必要があり@noteますか?

Answer 1

@note コマンドは、CSS ファイルまたは Latex を使用する場合のスタイル ファイルでフォーマットをカスタマイズできる段落になります。したがって、「通常の」テキストのようにマークアップを使用できます。

/**
 * Bla bla...
 *
 * @note Even in a note you can use markups:
 *       - Your first note
 *       - Youre second note
 *
 * The note section ends with an empty line or the end of the comment.
 */

Answer 2

どちらの方法でも実行できます。それは本当にスタイル/好みの問題です。

ご指摘のとおり、Doxygen には@noteコマンドがありますが、ありません@notes。@notesDoxyfile を編集し、ALIASES =読み取りタグを変更することで、独自のコマンドを作成できます。

ALIASES = "notes=@par Notes:\n"

これにより、ドキュメントにコマンドを配置できます。これにより@notes、見出しを持つユーザー定義の段落が作成されます。

ノート：

ALIAS タグの Doxygen ドキュメントで指摘されているように、エイリアスの値の部分に \n を挿入して改行を挿入できます。