Ako používať doxygen písať zdrojové kódy

Zdroj Vedenie kód udržiavateľný je jedným z najťažších problémov , ktorým čelia žiadny software developer , či osamelý vlk programátor alebo členom veľkého tímu . Doxygen umožňuje vytvárať dokumenty automaticky z C + + , Java , alebo iného kódu . Bude analyzovať neregulárna kód a napísať základné dokumentáciu , a môžete pridať špeciálne formátované komentáre do zdrojového kódu , aby sa užitočné dodatky k generovaného zdrojového kódu . Veci , ktoré budete potrebovať klipart Zdrojový kód klipart Textový editor
Zobraziť ďalšie inštrukcie Cestuj 1

Stiahnite a nainštalujte doxygen . Je k dispozícii na stack.nl /~ Dimitri /doxygen /download.html # latestsrc .
2

Otvorte príkazový riadok . V systéme Windows XP , môžete to urobiť kliknutím na ponuku Štart , voľbou Spustiť , zadaním " cmd " a kliknutím na tlačidlo OK . V systéme Mac OS , môžete kliknúť na ponuku Spotlight , typ terminálu , a vyberte Terminal , keď sa objaví. Prejdite príkazového riadku zdrojového kódu adresára zadaním " cd " , po ktorom nasleduje názov adresára a stlačením klávesu Enter .
3

Vytvorte Doxyfile zadaním " doxygen - g " a stlačením enter . To bude generovať súbor v aktuálnom adresári s názvom " Doxyfile , " ktorý bude obsahovať všetky predvolené možnosti doxygen . Môžete zmeniť tieto možnosti otvorením Doxyfile v textovom editore .
4

Pridať doxygen komentáre do zdrojového kódu . Doxygen komentáre sú normálne komentáre , ktoré obsahujú osobitné poznámky , ktoré umožňujú doxygen je nájsť a uviesť , ako by ich mali používať . Napríklad , ak píšete v jazyku C - štýle , môžete pridať krátky popis na funkciu pridaním nasledujúci komentár pred jeho vyhlásením :/* ! \\ Informovať Môj krátky popis * /Môžete vidieť všetky ďalšie poznámky doxygen podporuje v stack.nl /~ Dimitri /doxygen /docblocks.html .
5

typu " doxygen Doxyfile " na príkazovom riadku a stlačte klávesu Enter . To bude generovať dokumentáciu zdrojového kódu .

• Predchádzajúca strana: Ako vytvoriť C + + program v aplikácii Visual Studio 6.0 
• Ďalšia strana: Ako na Word Wrap Visual C