Dokumentation mit Doxygen

Dennis S. (eltio) 20.03.2013 11:10 #3094286

Lesenswert?

•

Hallo 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:

/** \file
 * \brief Beinhaltet Funktionen zum Einlesen von Daten.


und in der Header-Datei kommentiere ich die Prototypen:

/** \brief Liest Daten aus einer CSV-Datei. 
 *  \param *fileName Name der einzulesenden Datei
void readData(char *fileName);


Wie ist die "gängige" Praxis für die Nutzung von Doxygen in 
C-Quellcodes?

Gruß
Dennis

Beitrag melden Bearbeiten Thread verschieben Thread sperren Anmeldepflicht aktivieren Anpinnen Thread löschen Thread mit anderem zusammenführen Markierten Text zitieren Antwort Antwort mit Zitat

Georg A. (georga) 20.03.2013 12:59 #3094449

Lesenswert?

•

▲
▼

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.

Beitrag melden Bearbeiten Löschen Markierten Text zitieren Antwort Antwort mit Zitat

Stinkywinky Gast 21.03.2013 09:25 #3095778

Lesenswert?

•

▲
▼

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.

Beitrag melden Bearbeiten Löschen Markierten Text zitieren Antwort Antwort mit Zitat

Dennis S. (eltio) 21.03.2013 09:44 #3095813

Lesenswert?

•

▲
▼

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

Beitrag melden Bearbeiten Löschen Markierten Text zitieren Antwort Antwort mit Zitat

Thread beobachten

Antwort schreiben

Bitte melde dich an, um einen Beitrag zu schreiben.

Bestehender Account

oder

Mit Google-Account einloggen

Noch kein Account?

Die Registrierung ist kostenlos und dauert nur eine Minute.

Jetzt registrieren