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 10:47] – Giuseppe Di Terlizzi | programming:php-and-doxygen [2014/07/15 11:07] (current) – Giuseppe Di Terlizzi | ||
---|---|---|---|
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 101: | Line 103: | ||
| | ||
| '' | | '' | ||
+ | |||
==== Documentiamo ==== | ==== Documentiamo ==== | ||
Line 112: | 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 120: | 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 ===== |