Documentazione automatica del codice con Doxygen (HowTo)

di morpheus1820

Doxygen è un programma che permette di generare una documentazione automatica di codice in linguaggio C++, in modo abbastanza semplice. Per prima cosa installare Doxygen:

sudo apt-get install doxygen

Nella cartella principale del progetto C++ digitare:

doxygen -g <nomefile>

in questo modo si crea il file di configurazione di default <nomefile>. Non è necessario editare tutti i parametri, i più importanti sono:

PROJECT_NAME     = si commenta da sè
OUTPUT_DIRECTORY = cartella in cui generare la documentazione
INPUT            = percorso del codice  sorgente
FILE_PATTERNS    = Estensioni da considerare, per esempio .h,.cpp, .cc ecc...

A questo punto è possibile generare la documentazione in qualsiasi momento digitando

doxygen <nomefile>

Vediamo adesso come inserire nel codice la descrizione di classi, metodi, e attributi:

All’ inizio di ogni file

/*
 @file    fileName.cc .cpp .h ecc ecc ecc
 @author  name, mail
 @version 1.0
 */

Prima della dichiarazione di una classe:

/** Descrizione classe...
@code
... eventuale codice di esempio ...
 @endcode
 */

Prima di ogni metodo (o ridefinizione o template):

/**
Descrizione metodo...
@param  a parametro 1
@param  b parametro 2
@return valore di ritorno
@throws  eccezioni...
*/

Prima di ogni attributo:

/** descrizione */

La documentazione verrà generata in formato html nella cartella “html”.

Lascia un commento

Inserisci i tuoi dati qui sotto o clicca su un'icona per effettuare l'accesso:

Logo WordPress.com

Stai commentando usando il tuo account WordPress.com. Chiudi sessione / Modifica )

Foto Twitter

Stai commentando usando il tuo account Twitter. Chiudi sessione / Modifica )

Foto di Facebook

Stai commentando usando il tuo account Facebook. Chiudi sessione / Modifica )

Google+ photo

Stai commentando usando il tuo account Google+. Chiudi sessione / Modifica )

Connessione a %s...

%d blogger cliccano Mi Piace per questo: