Anzeige:
Ergebnis 1 bis 3 von 3

Thema: doxygen mit main()

  1. #1
    Registrierter Benutzer
    Registriert seit
    24.08.2004
    Beiträge
    749

    doxygen mit main()

    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?

  2. #2
    Registrierter Benutzer Avatar von Boron
    Registriert seit
    07.01.2002
    Beiträge
    827
    Code:
    /*! \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 .
    Gruß Boron (der sich oft wegen mieser Rechtschreibung anderer die Augen reiben muss)

    LINUX IS LIKE AN INDIAN TENT: NO GATES, NO WINDOWS AND AN APACHE INSIDE!
    Hardware Monitoring unter Linux -> http://santafu.sourceforge.net (Temperaturen, Lüfterdrehzahlen und Spannungen)

  3. #3
    Registrierter Benutzer Avatar von panzi
    Registriert seit
    04.05.2001
    Ort
    Kottingbrunn
    Beiträge
    609
    Zitat Zitat von Mat Beitrag anzeigen
    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.
    Intel Core 2 Duo CPU 2.66GHz; Nvidia GeForce 8 8800 GTS; 4GB RAM; Fedora 12; KDE-testing

Lesezeichen

Berechtigungen

  • Neue Themen erstellen: Nein
  • Themen beantworten: Nein
  • Anhänge hochladen: Nein
  • Beiträge bearbeiten: Nein
  •