Header-Kommentarformat

10

Mir ist klar, dass das Format "Header-Kommentar" von Programmierer zu Programmierer unterschiedlich ist, aber was wäre ein Beispiel für einen "guten" Header-Kommentar?

c++  coding-style  comments  code-formatting  headers 
— Mateen Ulhaq
quelle
Geht es bei dieser Frage nur um Formatierung oder um Stil und Inhalt?
— Macneil
@ Macneil Kommt darauf an, was sie bedeuten. Im Moment gehe ich auf Nummer sicher und sage "beides". :)
— Mateen Ulhaq

Antworten:

5

In Bezug auf den Formatierungsstil ist Konsistenz am wichtigsten. Stellen Sie sicher, dass jeder Klassendefinitionskommentar wie jeder andere aussieht , jeder Methodenkommentar wie jeder andere aussieht usw.

Wenn Sie also vorhandenen Code ändern , stellen Sie sicher, dass Sie dessen Formatierungsstil befolgen. Die Kommentare (und bis zu einem gewissen Grad auch der Code) sollten so aussehen, als hätte nur eine Person an der Datei gearbeitet. Wenn Sie ein neues Projekt starten, wählen Sie ein Stilformat und bleiben Sie dabei.

Orte, an denen man anfangen kann zu suchen:

— JK
quelle
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.