c# - 概要とパラメータ テキストの規則は?

Question

要約とパラメータのテキストを書くために、どのくらい詳細に入る必要があるか、完全な文を使用するかどうか、または何かについてのベスト プラクティスはありますか? これらをもっと使い始めると、確立するためのいくつかの良い習慣を探しています. ありがとう！

public class JustinBieber{
    private readonly bool HasTalent;
    JustinBieber(){
        HasTalent = false;
    }

    /// <summary>
    /// JustinBieber object sings a song in specified style
    /// </summary>
    /// <param name="songName">The song to be sung</param>
    /// <param name="style">The style in which the song is sung</param>
    public void SingSong(string songName, string style){
        ...
    }
} 

Answer 1

ここでの私の経験則は、意味を明確に伝えるのに十分な詳細を使用することです。

ここでは簡潔さを好みます。XML ドキュメントはインテリセンスに使用されるため、これは特に重要だと感じています。非常に長いコメントは簡単に表示されない傾向があるため、私はコメントを避け、<remarks>必要に応じて「長い」コメントを挿入します。