Im Grunde genommen ist das aber auch nichts anderes als das mit den
XML-Tags. Der eine tippt lieber, der andere klickt lieber (auf das DocInsight-Fenster).
Wichtig ist, *das* man es macht, und vor allen Dingen, *was* genau (mindestens) drin stehen sollte.
Schwierig wird es -generell- bei Kommentaren wie:
Delphi-Quellcode:
/// <summary>
/// Removes all unsolved references
/// </summary>
Procedure TMyClass.RemoveAllUnresolvedReferences;
Begin
End;
Aber bevor man in den ToolTips gar nichts sieht und sich fragt "Was macht die denn nun genau, die Methode", schreibt man lieber solch redundantes Zeugs rein. Aber vielleicht kann man mit 1-2 Sätzen noch Details beschreiben, oder ein Beispiel geben. Dann sieht das nicht ganz so bescheuert aus.
Wohlgemerkt: Nur bei öffentlichen Methoden. Private Methoden sind ja eh selbsterklärend.
Zitat
Baum-Darstellung
