Mantenere gestibile il codice sorgente è una delle più difficili sfide per qualsiasi sviluppatore di software, se un programmatore di lupo solitario o un membro di una grande squadra. Doxygen consente di generare automaticamente la documentazione da C++, Java o altro codice. Che analizzerà il tuo codice non documentato e scrivere documentazione di base, ed è possibile aggiungere commenti appositamente formattato al codice sorgente per rendere utili aggiunte al codice sorgente generato.

Istruzioni

1

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

2

Aprire un prompt dei comandi. Su Windows XP è possibile farlo facendo clic sul Menu Start, scegliendo Esegui, entrando \"cmd\" e facendo clic su OK. Su Mac OS, si può scegliere il menu Spotlight, digitare Terminal e scegliere Terminal viene visualizzato. Passare il prompt dei comandi di directory del codice sorgente del digitando \"cd\" seguito dal nome della directory e premendo INVIO.

3

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

4

Aggiungere Doxygen commenti al codice sorgente. Doxygen commenti sono normali commenti che contengono annotazioni speciali che permettono di Doxygen per trovarli e indicare come esso dovrebbe usarli. Ad esempio, se stai scrivendo in una lingua di tipo C, è possibile aggiungere una breve descrizione di una funzione aggiungendo il seguente commento prima sua dichiarazione:
/! \brief mia breve descrizione /
Potete vedere tutte le altre annotazioni che Doxygen supporta presso stack.nl/~dimitri/doxygen/docblocks.html.

5

Digitare \"doxygen Doxyfile\" sul prompt dei comandi e premere INVIO. Questo genererà la documentazione per il codice sorgente.