doxygenの関数内からコメントを抽出するにはどうすればよいですか?

C についてはわかりませんが、Objective-C で毎日実行しています。次のようなコメントがあります:

/// This method perform the following operations:
- (void) myMethodWith: (id) anObjectArgument
{
    /// - do op1
    [self op1];

    /// - do op2
    op2(anObjectArgument);
}

これは次のようにレンダリングされます:

編集: Dana the Sane のコメントに続き、Doxygen のドキュメントに関する私の理解と、それが私の経験と矛盾しない理由について

私が Doxygen のドキュメントを理解し解釈する限り、これは Aaron Saarela の引用と矛盾しません。彼が提供するリンクの冒頭に、本文内のドキュメントに関する段落があります:

これは、Doxygen のドキュメントを関数またはメソッド本体に配置しても問題ないことを意味します。これは、私の回答に加えて説明したものです。

私の意見では、アーロンが引用した段落は、通常、関数またはメソッドの宣言または実装の前に置かれるドキュメントを参照しています。これは、パラメーター、戻り値などを記述するものです。その見出し 関数またはメソッドの本体内にドキュメントを配置することはできません。

しかし、本体内のアルゴリズムの各ステップに関する詳細なドキュメントは、Doxygen によって完全に処理されます。


いいえ、doxygen は関数本体内のコメント ブロックをサポートしていません。マニュアルから:

セクション:コードを文書化する Doxygen


コード内のコメントは、特定の実装スニペットを別のプログラマーが理解できるように説明するためのものであり、ユーザーが読むための関数の機能ではありません。

ユーザー向けに文書化する必要がある場合は、外側で行う必要があります 関数ブロック、インターフェイスを定義するコメント (署名、事前条件、事後条件、使用例、または必要と思われるもの)。