Strumenti Utente

Strumenti Sito


roberto.alfieri:pub:doxygen

Doxygen

Doxygen e' un sistema per la documentazione del codice Crea documentazione on-line HTML, ma puo' generare anche LaTex, man e altri formati

http://algogroup.unimore.it/people/marko/courses/programmazione_II/programmazioneII-1213/13-Documentazione.pdf

Vantaggi

La documentazione e' scritta insieme al codice, quindi e' aggiornata, inoltre il codice solitamente viene commentato, quindi non c'e' lavoro in piu'; si tratta solo di commentare con una particolare sintassi.

I grafici delle relazioni sono generati automaticamente.

Svantaggi

bisogna usare la sintassi Doxygen

Commentare gli Header file

Le formule usano (Quasi) la stessa notazione di LaTex

Esempio:

/** commento */
void funzione_a()
roberto.alfieri/pub/doxygen.txt · Ultima modifica: 24/10/2014 11:11 da roberto.alfieri