6

doxygen が生成された html ファイルにコメントを入れることができるように、関数 (c、c++、java) にいくつかのコメントを含めることができるかどうかを知りたいです。

例えば：

function(...)
{
do_1();
/**
 * Call do_2 function for doing specific stuff.
 */ 
do_2();
}
4

4 に答える 4

17

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

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

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

次のようにレンダリングされます。

このメソッドは、次の操作を実行します。

  • op1をする

  • op2をする

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

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

コード項目ごとに 2 種類 (場合によっては 3 種類) の説明があり、これらが一緒になってドキュメントを形成します。簡単な説明と詳細な説明です。どちらもオプションです。メソッドと関数には、メソッドまたは関数の本体内にあるすべてのコメント ブロックの連結で構成される、いわゆる「本体内」記述と呼ばれる 3 番目のタイプの記述もあります。

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

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

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

于 2009-04-16T21:58:20.283 に答える
8

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

Doxygen を使用すると、ドキュメンテーション ブロックを事実上どこにでも配置できます (例外は、関数の本体内または通常の C スタイルのコメント ブロック内です)。

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

于 2009-04-16T21:30:43.393 に答える
5

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

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

于 2009-04-16T21:35:49.637 に答える
0

代わりに、関数のコードを例として挙げることができます。 http://www.doxygen.nl/manual/commands.html#cmd例

于 2009-04-16T21:40:15.570 に答える