Kommentare

[BKempf]

Ich versuche gerade, mir eine Art Richtlinie zurechtzulegen, nach der ich Kommentare schreibe.

Ich verwende

Delphi-Quellcode:

// 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

Delphi-Quellcode:

(*
  Code
*)

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

Delphi-Quellcode:

(**
  veralteter Code
**)

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?

[Meflin]

gan z einfach: für einzeilige kommentare oder zum kurzen deaktivieren nehme ich

Delphi-Quellcode:

//

und für alle mehrzeiligen kommentare

Delphi-Quellcode:

{ kommentar }

die anderen nehme ich garnicht her!

[fantotal]

Ich bin neu bei Delphi und noch nicht lange dabei, aber deine Art BKempf finde ich äusserst gut. Werde ich bei mir mal so einführen.

Danke

mfg
fantotal

[NicoDE]

Meine Angewohnheiten...

Delphi-Quellcode:

// Kommentar

Für fast alle Kommentare (eigene Zeile)

Delphi-Quellcode:

{ Kommentar }

Nur noch bei Header-Übersetzungen und D2-Quellen (falls sinnvoll).

Delphi-Quellcode:

(** )
  Code1
(**)
  Code2
(**)

Um Test-Blöcke umzuschalten.

[Kernel32.DLL]

Bei Einzeilern:

Delphi-Quellcode:

//Kommentar

Bei Mehrzeiligen Kommentaren:

Delphi-Quellcode:

{Comment: 
Kommentar}

Bei Mehrzeilligen, Deaktivierten Codestücken

Delphi-Quellcode:

{deactivated:
Code}

Bei kleineren Proggis kommentier ich allerdings nicht, sondern wähle selbsterklärende Prozedur-, Funktion- und Variablennamen

[Nicodius]

Delphi-Quellcode:

// Titel etc...(bei prozedureköpfen)
          inc(i); // Zählt i um eins hinauf
 

        Say('Hallo', 'and praise', 'TEST'); { bei längeren texten verwende ich die klammern
                                              oder wenn es sich nicht bis zum Rand ausgehen würde}


        Readaword(Form1,Label1.caption); // liest ein wort aus einer caption heraus

die (**) verwende ich praktisch nie und WENN dann bei Klassenerklärungen etc

[Christian Seehase]

Moin Zusammen,

also ich für meinen Teile verwende nur //, auch bei mehrzeiligen Kommentaren.
Gexperts sei Dank ist das ja nur ein einziger Klick ;-)

[MrKnogge]

Kannst du mal sagen was "Gexperts" ist, bzw. wie man es anwendet ?

[Christian Seehase]

Moin MrKnogge,

schau mal bei www.gexperts.org.
Kurz gesagt eine Erweiterung der Delphi IDE, mit vielen nützlichen Tools (z.B. auch Kommentarheader für Units/Methoden usw. auf Tastendruck)

[NicoDE]

Zitat:

Zitat von MrKnogge

Kannst du mal sagen was "Gexperts" ist, bzw. wie man es anwendet ?

http://www.GExperts.org/