Doxygen, sistema di documentazione codice

Premessa

Finalmente ci siamo... dopo settimane se non mesi passati a programmare ecco che il software che avevi pensato tempo fa e al quale hai dato forma nel tempo pronto per il suo debutto...
Lo fai girare, lo osservi mentre legge la configurazione e... tutto sembra funzionare.
A quel punto, dopo la soddisfazione iniziale arriva l'incubo del programmatore: documentare il proprio codice per fare in modo che se qualcun altro o tu stesso fra due anni devi modificare il programma, sappia cosa faceva quella specifica funzione...
A questo scopo sono a presentarvi Doxygen, un sistema di documentazione del codice molto semplice e potente.

Doxygen

Doxygen è un software che legge uno o più file contenenti del codice di programmazione.
Analizza i commenti presenti e, se formattati adeguatamente, genera della documentazione fruibile.
Detto in altre parole, basta inserire commenti nel proprio codice che spieghino in modo dettagliato le funzioni, le variabili, le classi (pratica di solito sempre auspicabile) e Doxygen farà il resto...
Questo software multipiattaforma (gira su Linux, Windows e Mac) è nato per la documentazione del codice in C ma oggi riconosce codice in Java, python, perl, php e molti altri.
La cosa più interessante di questo software è la semplicità d'uso: dopo aver aperto una utility grafica che aiuta nella creazione di un file di configurazione, basta lanciare l'eseguibile doxygen e, come per magia, vedrete apparire la documentazione nella cartella specificata.
Una caratteristica affasciante sono gli output disponibili in questo software: la documentazione, infatti, può essere generata in un gradevole formato HTML (estremamente configurabile con CSS) pronto da pubblicare su un sito web o una intranet, in formato RTF o LaTeX (e quindi PDF).
Insomma, per chi sta cercando un modo semplice e veloce per documentare il proprio codice, Doxygen è un ottimo punto di partenza, semplice, veloce, estremamente configurabile, multipiattaforma e multilinguaggio. In poche parole è solo da provare!