3 Stimmen

Konventionen für Zusammenfassung und Parametertext?

Gibt es für das Verfassen von Zusammenfassungen und Parametertexten eine bewährte Methode, wie detailliert man vorgehen muss, ob man vollständige Sätze verwenden sollte oder nicht, oder was auch immer? Ich bin auf der Suche nach ein paar guten Gewohnheiten, die ich mir angewöhnen kann, wenn ich anfange, sie häufiger zu verwenden. Vielen Dank!

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){
        ...
    }
}

3voto

Reed Copsey Punkte 536986

Meine Faustregel lautet hier, dass man nur so viele Details verwenden sollte, dass die Bedeutung klar vermittelt wird, und nicht mehr.

Ich bevorzuge hier Prägnanz - und halte dies für besonders wichtig, da die XML-Dokumentation für die Intellisense verwendet wird. Sehr lange Kommentare neigen dazu, dort nicht gut sichtbar zu sein, daher würde ich sie vermeiden und die "längeren" Kommentare in <remarks> falls erforderlich.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X