Hi!
Ich suche nach Informationen oder Erfahrungen von Entwicklern, wie man am besten Sourcecode (speziell C++) kommentieren sollte, damit die Kommentare einheitlich und gut verarbeitbar sind. Gibt es (Quasi-)Standards?
Ich meine Beschreibung von Klassen, Membern, Methoden und Variablen im Code. Sie sollen sich zur Erstellung einer (Klassen-/Funktions-)Referenz eignen. Schön wäre auch die Nutzung in einer IDE zur Unterstützung bei der Programmierung.
Ich habe etwas mit Javadoc bzw. dem Tool doxygen gespielt und die Möglichkeiten gefallen mir schon gut. (kdoc und doc++ wollte den Code nicht akzeptieren)
Wie sollte man solche Kommentare am besten einbauen? Wie detailliert sollten sie sein? - Javadoc-Syntax? (Vorteil: Quasi-Standard, aber Javadoc für C++-Code? ;-) - eine Variante, die Tool XYZ verwendet? (Nachteil: evtl. nicht von anderen Tools verarbeitbar) - In welche Dateien gehören diese Kommentare? *.cxx oder *.hh?
Ich bin auf Hinweise bzw. Erfahrungen aus der Praxis gespannt.
Freundlich grüßend, Erik