|
Anzeige
|
Dokumentation mit DoxygenHallo zusammen, In meinem Programm habe ich Header- und Source-Files getrennt. Zur Zeit habe ich in der .c-Datei lediglich einen kurzen Kommentar am Anfang der Datei:
und in der Header-Datei kommentiere ich die Prototypen:
Wie ist die "gängige" Praxis für die Nutzung von Doxygen in C-Quellcodes? Gruß Dennis Was gängig ist, weiss ich nicht. Für sinnvoll halte ich es jedenfalls, Funktionen/Methoden im C-File zu kommentieren, weil man selber gleich sieht, was "alles los" ist. Das kann die Doku nur verbessern. Im Headerfile mache ich das nur für Klassenvariablen etc. Doxygen fügt das ja dann eh alles zusammen.
Gast
#3095778
Man könnte in den Header-Dateien die Anwender-Doku beschreiben (Schnittstellen, etc) und in den C-Files die Entwickler-Dokumentation. Nun kann man mit zwei Durchläufen von doxygen Anwender- und Entwickler-Doku separat generieren. Hmm... danke für die Anregungen. Ich habe es jetzt erstmal so realisiert, dass ich die Schnittstellenbeschreibung (d.h. Doxygen-Kommentare) in den Header-Dateien mache und in der Implementierung nur "normale" Kommentare. Gruß Dennis Antwort schreibenBitte melde dich an, um einen Beitrag zu schreiben. |
Anzeige
|
