.Netツールからドキュメントメソッドへ

Question

私の会社からすべての.Net Webサービスを文書化し、それらのサービスのすべてのメソッドのシグネチャ（つまり入力と出力）を提供するように求められました。これを行い、文書や要約を返すツールがありますか？これは私に多くの時間を節約し、コードの束を見なければならなくなるのを止めます。

ありがとうございます！

Answer 1

Doxygenこれは非常にうまくいっています。 this pageからリンクされている例を見ることができます。

Answer 2

Sandcastle。 簡単な使い方についてはthisを参照してください。 Sandcastle Help File Builderは非常に便利です。

サンドキャスルはmsdnのようなドキュメントを作成します。 Visual Studio内のGhostDocを使用して、すべてのコメントを実際に行います。

Answer 3

あなたはこのようなメソッドにXMLコメントを追加することができます。

/// <summary> 
    /// Method summary. 
    /// </summary> 
    /// <param name = "asdf">Parameter description.</param> 
    /// <returns>Return value summary.</returns> 
    public object SomeMethod(object asdf) { 
     return null; // but really, do something fun 
    } 

Answer 4

GhostDocは、文書化されていないコードを文書に最初のスタートを取得するための素晴らしいです。

XMLドキュメントは、サンドキャッスルのUIフロントエンドSandCastle Help File Builderを経由してエクスポートすることができ、HTMLHelp、HTML、およびMSヘルプファイルビューアーの出力が得られます。

Answer 5

私が思うように、サンキャスルが最もよく使われています。とりわけ

があります：

• NDoc
• Docu
• Doxygen

あなたがソースコード内の既存のXMLコメントをお持ちでない場合は、GhostDocプラグインは標準を生成する際に大きな助けを提供しています後で修正できる定型的なコメント。