Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
programming:php-and-doxygen [2014/07/15 09:40] – Giuseppe Di Terlizzi | programming:php-and-doxygen [2014/07/15 11:07] (current) – Giuseppe Di Terlizzi | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Commentare e documentare con stile grazie a Doxygen ====== | ====== Commentare e documentare con stile grazie a Doxygen ====== | ||
- | Con questo articolo affronteremo un' | + | Con questo articolo affronteremo un' |
- | Avere un codice ben commentato non solo facilita coloro che mettono mani ad un progetto già avvitato ma aiuta anche in fase di coding in quanto oggigiorno la stragrande maggioranza degli IDE supporta l' | + | Avere un codice ben commentato non solo facilita coloro che mettono mani ad un progetto già avvitato ma aiuta anche in fase di debug per capire perchè abbiamo scritto quella determinata funzione ed aiuta in fase coding in quanto oggigiorno la stragrande maggioranza degli IDE supporta l' |
===== Doxygen ===== | ===== Doxygen ===== | ||
- | **Doxygen** è un applicazione multipiattaforma (Windows, Linux, MacOSX, etc.) che permette di creare documentazione partendo | + | **Doxygen** è un applicazione multipiattaforma (Windows, Linux, MacOSX, etc.) che permette di creare documentazione partendo |
Grazie all' | Grazie all' | ||
- | ==== Un esempio | + | |
+ | ==== Esempio di codice commentato | ||
Di seguito un esempio di classe che utilizza alcuni dei comandi di **Doxygen**. | Di seguito un esempio di classe che utilizza alcuni dei comandi di **Doxygen**. | ||
Line 56: | Line 57: | ||
} | } | ||
</ | </ | ||
+ | |||
==== Comandi più utilizzati ==== | ==== Comandi più utilizzati ==== | ||
Line 96: | Line 98: | ||
| '' | | '' | ||
| '' | | '' | ||
+ | | '' | ||
+ | * @version | ||
+ | * @since | ||
+ | | ||
+ | | '' | ||
+ | |||
==== Documentiamo ==== | ==== Documentiamo ==== | ||
Line 105: | Line 113: | ||
$ doxygen -g < | $ doxygen -g < | ||
| | ||
- | Successivamente è necessario personalizzare la configurazione | + | Successivamente è necessario personalizzare la configurazione |
- | <div info round center 80%>Per chi non vuole sporcarsi le mani tra le centinaia di flag, Doxgen | + | <div info round center 80%>Per chi non vuole sporcarsi le mani tra le centinaia di opzioni disponibili, Doxygen |
$ doxywizard < | $ doxywizard < | ||
Line 115: | Line 123: | ||
$ doxygen < | $ doxygen < | ||
+ | |||
+ | | ||
+ | ==== Configurazioni utili per codice in PHP ==== | ||
+ | |||
+ | Per documentare il nostro codice PHP è necessario utilizzare l' | ||
+ | |||
+ | OPTIMIZE_FOR_C = YES | ||
+ | |||
+ | Grazie all' | ||
+ | |||
+ | INPUT_FILTER = php php_var_filter.php | ||
+ | |||
+ | Scarichiamo il file qui sotto e lo copiamo nella stessa directory del file di configurazione di Doxygen: | ||
+ | |||
+ | <file .php php_var_filter.php> | ||
+ | /** | ||
+ | * FIX " | ||
+ | * | ||
+ | * @fixme | ||
+ | * @see http:// | ||
+ | * @see https:// | ||
+ | */ | ||
+ | |||
+ | $source = file_get_contents($argv[1]); | ||
+ | |||
+ | $regexp = '# | ||
+ | $replac = '${2} */ ${3} ${1} ${4}'; | ||
+ | $source = preg_replace($regexp, | ||
+ | |||
+ | echo $source; | ||
+ | </ | ||
+ | |||
+ | Come output consiglio l'HTML in quanto permette la navigazione ipertestuale oltre alla possibilità di utilizzare il motore di ricerca interno per ricercare una funzione o metodo specifico. | ||
+ | |||
+ | GENERATE_HTML = YES | ||
===== Per maggiori informazioni ===== | ===== Per maggiori informazioni ===== |