요약 및 매개 변수 텍스트의 규칙?

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 문서가 인텔리 센스 (intellisense) 용으로 사용되므로 여기서는 간결함을 선호합니다. 특히 중요하다고 생각합니다. 매우 긴 주석은 쉽게 보이지 않는 경향이 있으므로 필 요한 경우이를 피하고 "긴"주석을 <remarks>에 넣습니다.