Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision | ||
programming:php-and-doxygen [2014/07/15 10:29] – [Doxygen] Giuseppe Di Terlizzi | programming:php-and-doxygen [2014/07/15 11:02] – 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 ===== | ||
Line 11: | Line 11: | ||
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 107: | Line 115: | ||
Successivamente è necessario personalizzare la configurazione appena prodotto in base ai nostri gusti. In particolare dobbiamo specificare il nome del progetto ('' | Successivamente è necessario personalizzare la configurazione appena prodotto in base ai nostri gusti. In particolare dobbiamo specificare il nome del progetto ('' | ||
- | <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 PHP è necessario utilizzare l' | ||
+ | |||
+ | <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; | ||
+ | </ | ||
+ | |||
+ | Per abilitare il filtro, basta editare l' | ||
+ | |||
+ | INPUT_FILTER = php php_var_filter.php | ||
+ | |||
+ | 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 ===== |