0

プロジェクトを作成し、それを文書化する作業を開始しました。Sandcastle は XML コメントを使用して適切なヘルプ ファイルを作成しますが、XML コメントはコードをほとんど判読できないままにします。私が書いた各クラスは、次のようなものから始まります。

/// <summary>
/// Summary of Foo class
/// </summary>
public class Foo
{
    ///<summary>
    ///Summary of bar</summary>
    public int bar;
    ///<summary>
    ///Summary of bat</summary>
    public String bat;

    ///<summary>
    ///Summary of constructor</summary
    ///<param name="a">description of a</param>
    ///<param name="b">description of b</param>
    public Foo(int a, int b)
    ....
}

適切なヘルプ ファイルを作成するのに十分な情報を残しながら、このコードをクリーンアップする方法はありますか?

4

3 に答える 3

3

よくわからない場合は、こちらをご覧ください... http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

そして、ここに彼らの例があります: http://msdn.microsoft.com/en-us/library/aa288481(v=vs.71).aspx

しかし、それは正直なところ、それがどのように見えるべきかです。変更を加えない限り、私は通常、すべてを最小限に抑えます。しかし、このような完全な XML ドキュメントは、新しい開発者がプロ​​ジェクトに参加する場合に天の恵みとなる可能性があります。

ただそれと戦い、うまくいけばそれを愛することを学びますか?

于 2013-05-15T13:24:47.323 に答える
0

include タグを使用すると、ほとんどのドキュメントを個別のファイルに入れることができます。通常、これは、仮想メンバーまたはインターフェイス メンバーのさまざまな実装で共通のドキュメントを再利用するために使用されますが、単にドキュメントを分離するために使用することもできます。

于 2013-05-25T15:05:50.990 に答える