Kurzfrage doxygen unter kdevelop3->/// vs. // in .cpp dateien

[Mat]

Hallo,
ich habe gelesen dass man mit doxygen mit den drei slashes /// kommentare bilden kann die dann mit doxygen verarbeitet werden.

Jetzt ist meine frage. ich habe bisher nur meine .h dateien mit doxygen kommandos ausgebaut. In den .cpp dateien habe ich nur mit den normalen C++ // Kommentar zeichen gearbeitet.
Macht das so sinn?

Kann man denn die .cpp dateien unter doxygen irgendwie sichtbar machen also dass er auch deren Quellcode anzeigt weil bisher zeigt er bei mir nur die .h dateien an.

Oder bildet er mit den /// kommentarzeichen dann spezielle irgendwie diese dann auch von den .cpp dateien ein?

Danke

[Boron]

Doxygen extrahiert nur Kommentare die "Doxygen-Kommentare" sind.
Und da gibt es verschiedene Möglichkeiten:
- /**
- /*!
- ///
- //!
(habe ich was vergessen?)

"Normale" Kommentare, also // oder /* */ werden von Doxygen ignoriert!

Ich habe mir angewöhnt nur solche Kommentare zu verwenden, weil es C-Compiler gibt, die die Zeilenkommetare // nicht verstehen:
/*! \brief Kurzbeschreibung
*
* Nach einer Leerzeile eine ausführliche Beschreibung
*
* \param x toller Parameter (ab hier halt alle die speziellen Doxygen-Befehle)
*/Dieses Schema funktioniert für alle Funktionen, Variablen und Defines.

Und wenn du wirklich ALLES extrahiert haben willst, dann setze im Doxyfile mal die Option EXTRACT_ALL auf Yes. Dann sollte er, glaube ich auch, Links zu den *.c und *.cpp Dateien erstellen. Will heißen, dass er dann auch die *.cpp Dateien anzeigt.

[xmarvel]

um die links zu cpp dateien zu haben ohne EXTRACT_ALL anzuschalten mach ich immer am Anfang einer cpp Datei folgendes


/** \file
* \brief $Id$
*
* LICNESE TEXT MEIST GPL ;)
*/


Sowas ist ganz schön wenn man noch CVS benutzt dann hat man gleich die letzen Änderungsangaben in Doxygen mit drin.

MfG
xmarvel

[Mat]

Spitze!!!
Danke, natürlich hab ich durch eure Hilfe mein Problem gelöst.

Hätte noch ne kurze Frage. Ist es üblich nur in den .h Dateien mit Doxygen Kommentaren zu kommentieren oder macht es auch Sinn zusätzlich mit Doxygen-Kommentaren in den .cpp Dateien zu kommentieren?
Oder reicht es mit den standard C++ Kommentaren // in den .cpp Dateien zu kommentieren wenn man die src-en dann eh in der Doku anzeigen lässt ?

Danke für eure große Hilfe!

[xmarvel]

Spitze!!!
Danke, natürlich hab ich durch eure Hilfe mein Problem gelöst.

Hätte noch ne kurze Frage. Ist es üblich nur in den .h Dateien mit Doxygen Kommentaren zu kommentieren oder macht es auch Sinn zusätzlich mit Doxygen-Kommentaren in den .cpp Dateien zu kommentieren?
Oder reicht es mit den standard C++ Kommentaren // in den .cpp Dateien zu kommentieren wenn man die src-en dann eh in der Doku anzeigen lässt ?

Danke für eure große Hilfe!

Bin kein Profi also keine Ahnung wie man das üblich macht.
Aber ich kommentiere die Klasse und die Member Variablen der Klasse in der Header Datei und in der CPP Datei dann meine Methoden.
Da mir das sonst zu undurchsichtig wird in der Header Datei wenn ich dort alle Methoden noch mitkommentiere.
Und in den Methoden selber kommentiere ich ganz normal ohne Doxygen Style wenn es notwendig ist.

MfG
xmarvel

[Kirsche]

Hallo Mat,

ich habe mein Programm genauso wie xmarvel kommentiert. Ich glaube, das ist wirklich schön übersichtlich.

Schöne Grüße,