Legend for short and text text?

Is there a best practice for writing a summary and text of parameters for how many details you need to get, use or not use full sentences, or something else? I'm just looking for some good habits to establish when I start using them more. Thank!

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){
        ...
    }
} 
+3
source share
1 answer

My rule of thumb here is to use enough detail to clearly convey meaning, and no more.

- , , XML- intellisense. , , , , " " <remarks>.

+3

Source: https://habr.com/ru/post/1792849/


All Articles