10

私は、doxygen が C# コードのドキュメントを生成するための方法であることをどこでも読んできました。最初にドキュメント化したいインターフェースが 1 つあり (ベイビー ステップ)、そこには既に XML コメント (///) が含まれています。

これらのコメントはすでにサポートされているという膨大な数の投稿や情報 (doxygen.org を含む) があるため、doxywizard を実行すると、「警告: 化合物会社::製品::MyInterface は文書化されていません」。

これは、私が何らかの形で XML ドキュメントを誤解したか ( MSDNによれば、私が正しいことを話しているのではないことを願っています)、または doxywizard の構成を誤っていると思わせます。

最初に [ウィザード] タブから doxywizard を実行し、C#/Java をサポートすることを指定しました。実行すると、おそらく前述の警告が原因で、HTML ページが空白になります。次に、[エキスパート] タブで 1 つのファイルを指定して、もう一度実行しました - 同じ動作です。

doxygen で HTML を生成するために欠落しているスイッチまたは設定を誰か教えてもらえますか?

ドキュメント化されたプロパティ/メソッドが私のインターフェイスでどのように見えるかの例を次に示します。

/// <summary>
/// Retrieve the version of the device
/// </summary>
String Version { get; }

/// <summary>
/// Does something cool or really cool
/// </summary>
/// <param name="thing">0 = something cool, 1 = something really cool</param>
void DoSomething( Int32 thing);

次のように、インターフェイスの上にコメントがあります。

/// <summary>
/// MyInterface
/// </summary>
public interface MyInterface {...}
4

1 に答える 1

10

私はそれを理解したと思います。doxygen のマニュアルには、EXTRACT_ALL = 0 がデフォルト設定であり、この場合「文書化されたメンバー、ファイル、クラス、および名前空間の文書のみを生成する」と記載されています。今、私はそれらを適切に文書化したと思っていましたが、明らかにそうではありませんでした. EXTRACT_ALL を有効にしたところ、警告がなくなり、インターフェイスのドキュメントが表示されました! 「特別なドキュメントブロック」を読んで、何かが足りないと思った(Eric Farrのコメントのおかげ)が、C#コードに対して特別なことをすることについては言及されていないので、EXTRACT_ALLのデフォルト値はまだ働いています。

于 2011-08-31T13:47:14.577 に答える