PDA

Archiv verlassen und diese Seite im Standarddesign anzeigen : doxygen mit main()



Mat
05-09-2008, 14:38
Hallo,

ich weiß nicht so recht wo ich es posten soll..
Ich habe eine lange main() methode und würde gerne in doxygen die main() so dokumentiert bekommen wie eine eigene klasse. wie bekomme ich das hin?
Oder wie macht ihr das um eine lange main zu dokumentieren?

Boron
05-09-2008, 16:32
/*! \brief Dies ist die kurze Beschreibung von main()
*
* Und hier folgt die höllenlange und unglaublich ausführliche Beschreibung
* über jede noch so unwichtige Einzelheit:
* - Sinn und Zweck
* - Kochrezepte
* - usw.
*
* Man könnte auch Bilder/Diagramme einfügen. */
int main( int argc, char* argv[] )
{
// Was immer Ihr wollt
}Bei uns im Betrieb reicht es so :).

panzi
06-09-2008, 23:37
Hallo,

ich weiß nicht so recht wo ich es posten soll..
Ich habe eine lange main() methode und würde gerne in doxygen die main() so dokumentiert bekommen wie eine eigene klasse. wie bekomme ich das hin?
Oder wie macht ihr das um eine lange main zu dokumentieren?

Als Richtwert der Länge einer Methode nimmt man in der Regel eine Bildschirmseite. Alles was länger ist wird unübersichtlich und schlecht zu maintainen. Ich würde empfehlen: Brich die Methode auf in kleinere und dokumentiere alle resultierenden Methoden wie gewohnt.