Mantenere il codice sorgente mantenibile è una delle sfide più difficili di fronte a qualsiasi sviluppatore di software, se un lupo solitario programmatore o un membro di una grande squadra . Doxygen consente di generare automaticamente la documentazione da C + + , Java , o altro codice . Si analizzerà il vostro codice non documentato e scrivere documentazione di base , ed è possibile aggiungere commenti appositamente formattati per il codice sorgente per rendere utili integrazioni al codice sorgente generato . Cose che ti serviranno
Fonte codice
Text Editor
Show More Istruzioni
1

Scaricare e installare Doxygen . E 'disponibile presso stack.nl /~ dimitri /doxygen /download.html # latestsrc .
2

Aprire un prompt dei comandi . In Windows XP è possibile farlo facendo clic sul menu Start, scegliere Esegui , digitare " cmd" , e fare clic su OK . In Mac OS, è possibile fare clic sul menu Spotlight , il tipo di terminale , e scegliere Terminal quando viene visualizzato. Navigare il prompt dei comandi nella directory di codice sorgente digitando "cd" seguito dal nome della directory e premere Invio.
3

Creare un Doxyfile digitando " doxygen - g" e premendo Invio. Questo genererà un file nella directory corrente chiamata " Doxyfile ", che conterrà tutte le opzioni predefinite Doxygen . È possibile modificare queste opzioni aprendo il Doxyfile in un editor di testo .
4

Aggiungi commenti Doxygen al codice sorgente . Doxygen commenti sono normali commenti che contengono annotazioni speciali che consentono Doxygen trovarli e indicare come li deve utilizzare . Ad esempio , se si sta scrivendo in un linguaggio C -style , è possibile aggiungere una breve descrizione di una funzione con l'aggiunta del seguente commento prima della sua dichiarazione :/* ! \\ brief mia breve descrizione * /Potete vedere tutte le altre annotazioni Doxygen supporta al stack.nl /~ dimitri /doxygen /docblocks.html .
5

Tipo " doxygen Doxyfile " sul prompt di sistema e premere Invio . Questo genererà la documentazione del codice sorgente .