Da qualche tempo ho cominciato a sentire la necessità di avere un po’ di documentazione interna al software che scrivo.
E visto che ultimamente pare che sia costretto a scrivere codice solo in php, la scelta è ovviamente caduta su phpDocumentor.

Ora, tralasciando le gioie e i dolori di questo strumento di documentazione automatica stile javadoc, quello che vorrei riportare qui è come integrarlo in una installazione di xampp installandolo come pacchetto pear e comprensivo di interfaccia web.

Certo, phpDocumentor lo si può anche semplicemente scaricare e utilizzare tramite riga di comando utilizzando lo script phpdoc.bat (se siete su winzozz) ma vuoi mettere con l’interfaccia web? del resto la vita mi ha portato ad essere un sviluppatore web (anche contro la mia volontà )

dunque la prima cosa da fare è creare un bel vhost per l’apache del nostro xampp. apriamo quindi [directory_dove_sta_xampp]/apache/conf/extra/http-vhost.conf e aggiungiamo la descrizione di un vhost per PEAR:

###PEAR
<VirtualHost *:80>
DocumentRoot "G:/siti/PEAR"
ServerName pear.superbombo
</VirtualHost>

<Directory "G:/siti/pear">
Options Indexes FollowSymLinks Includes ExecCGI
AllowOverride All
Order allow,deny
Allow from all
</Directory>

indicando ovviamente una DocumentRoot e un ServerName adeguati.
nel file host di windows si deve naturalmente inserire il riferimento al servername indicato.
dopodichè riavviando apache il vhost sarà pronto.

a questo punto bisogna indicare a PEAR in quale directory operare. Per far questo apriamo il prompt di wincozz e facciamo:

c:\>cd [directory_dove_sta_xampp]/php
c:\>pear config-set data_dir [la document root del vhost]


dopodiche scarichiamo e installiamo phpDocumentor:

c:\>pear install -a PhpDocumentor


fatto ciò collegandosi a http://[ServerName]/PhpDocumentor ci si collegherà all’interfaccia web di PhpDocumentor dalla quale si potranno creare tutte le autodocumentazioni che si vuole.

enjoy