Könnte jemand bitte ein geeignetes Format für Kommentare vorschlagen, das ich in einem C++-Projekt verwenden sollte? Ich denke, dass es eine Analogie gibt zu javadoc Format, aber ich kann nicht herausfinden, welches es ist. Gibt es einen de-facto-Standard dieser Art? Vielen Dank!
Antworten
Zu viele Anzeigen?
Doxygen wird recht häufig für C++-Projekte verwendet (Doxygen unterstützt auch andere Sprachen). Sie können Kommentare im Doxygen-Stil als Ausgangspunkt verwenden ( Hier einige Beispiele ). Seien Sie einfach konsequent.
Norman Gray
Punkte
11293
Ihre Erwähnung von javadoc lässt vermuten, dass Sie an Folgendes denken doxygen . Dies ist ein Kit, das strukturierte Kommentare in C++ und anderen Sprachen unterstützt und Ausgaben in HTML und (wenn ich mich recht erinnere) PDF erzeugen kann. Es unterstützt eine Vielzahl von Kommentarstilen, darunter einen, der javadoc sehr ähnlich sieht.
Es funktioniert gut und wird breit eingesetzt.
Matthieu M.
Punkte
266317
Das Thema ist in allen Sprachen sehr umstritten.
Obwohl ich die Doxygen-Antworten schätze, da es sich um eine Art De-facto-Standard handelt, unterstützt Doxygen selbst mehrere Formate.
C++ unterstützt 2 Arten von Kommentaren:
/**/mehrzeiliger Kommentar//bis zum Ende des Zeilenkommentars
Ich würde davon abraten, die erste Variante zu verwenden. Das Problem ist, dass er nicht verschachtelt, was ziemlich ärgerlich ist, wenn man zu Testzwecken einen ganzen Codeblock auskommentieren möchte.
Meine 2 Cents, wie man so schön sagt.
