Ich versuche gerade, mir eine Art Richtlinie zurechtzulegen, nach der ich Kommentare schreibe.
Ich verwende
// Kommentar
fuer Einzeiler oder Kommentare, die zunaechst aus einer Zeile bestanden und spaeter auf max. 3-4 Zeilen angewachsen sind.
Wenn ein Kommentar laenger ist, schreibe ich
Delphi-Quellcode:
{Zeile 1
Zeile 2
Zeile 3
Zeile 4
}
.
Die abschliessende Klammer steht auf einer Höhe mit der öffnenden. Das sieht zwar nicht toll aus, erleichtert mir aber das Erkennen des Kommentarendes, weil ich Kommentare manchmal auf mehrere direkt aufeinander folgende Blöcke aufteile, wenn die Bemerkungen thematisch zu verschieden sind.
Die Sternkommentare
verwende ich, um Code kurzzeitig zu deaktivieren, und auch, um alte Versionen von Codeteilen, die ich eventuell noch benötige, aufzuheben (z.B. wenn ich eine Prozedur verbessert habe, aber noch nicht ausreichend getestet, so dass eine funktionierende Fallbacklösung Sinn macht).
Um besser zwischen wirklich nur "mal eben" abgeschalteten und veralteten Codeteilen unterscheiden zu können, überlege ich gerade, ob ich
als Markierung für veraltete (aber evtl. schon getestete und damit sichere) Lösungen einführe. Die könnten dann, wenn die neuen (besseren) Lösungen getestet sind, einfacher aufgespürt und gelöscht werden.
Wie verwendet ihr die unterschiedlichen Kommentartypen?