Dokumentation wohin?

[Sym]

Hallo,

wie sicher die meisten hier wissen, ist eine vernünfitge Dokumentation das A und O beim Programmieren. Bisher habe ich die Java API Specs für meine Projekte genutzt. Jetzt lerne ich jedoch C++ und habe mich da mal umgesehen. Ich fand Doxygen und konnte es relativ einfach via Skript mit in mein xCode einbinden.

Meine Frage ich jetzt, wo ich designtechnisch die Dokumentation (Methodenkopf, etc) einbinde. Schreibe ich es in die Headerfiles oder in die eigentlichen C++-files? In meinen .h-files habe ich den Parametern eigentlich keinen Namen gegeben, sondern dies erst in der cpp-Datei getan. Oder handhabt man das anders?

[Boron]

Ich schriebe die Doxygen Kommentare auch immer in die cpp Dateien.
Ich finde, dass die Header Dateien lesbar und übersichtlich bleiben sollte, auch wenn die Doku existiert und deshalb eignetlich keiner mehr in die Header schauen müsste.

Und ob du den Parametern der Methoden in den Headern schon Namen gibst oder nicht ist ja egal. Es gibt keinen Compiler der motzt, wenn die Namen in den Headern fehlen.

Aus Gründen der Lesbarkeit (siehe 1. Absatz) schreibe ich die Namen schon in die Header. Weil nämlich ein "sprechender" Name eines Parameters den Zweck des Parameters sofort klar macht.
stringCopy( String, String);
stringCopy( String source, String target);

// Was ist lesbarer?Dass dann evtl. die Zeilen zu lang werden zähl nicht als Argument, wenn der Code lesbar ist und wartbar bleibt.

[anda_skoa]

Ich schreibe die API Dokumentation immer einheitlich in den Header, sonst hat man den Kommentar teilweise im Header und teilweise in der Source Datei.

Ciao,
_

[Sym]

Hi,

danke für die Antworten. So wie es aussieht gibt es da keine einheitliche Regelung. Ich schreibe die KlassenDoku jetzt in den Header und den Rest in die Source-Datei. Ich finde das übersichtlich und das Header-File sieht nicht so zerrupft aus.

Gruß