ugrás a tartalomhoz

PHPDocumentor a mindentudó

_pp_ · 2003. Szep. 22. (H), 13.26
Nemrég volt szó a PHPDoctor dokumentációkészítő programról, mely egyszerűségével és gyorsaságával kápráztatott el minket. Eléggé régen esett szó azonban a PHPDocumentorról, mely azóta rengeteget fejlődött, és egy sokkal nagyobb tudású eszközzé vált.

A PHPDocumentor azon kívül, hogy a PHPDoctornál jóval több javaDoc elemet valósít meg képes több formátumba is dolgozni.

A PHPDoctor készítői a @param és @return elemeknél nem adták meg az adattípus tulajdonság meghatározási lehetőséget. Igaz ugyan, hogy a PHP nyelv változói nem tipizáltak, de a program írójának lehetőséget kell adni arra, hogy jelezhesse milyen típusú adatokat vár el. A PHPDocumentor használatával a típusok mind a forráskódban, mind pedig a dokumentációban megjelenhetnek.

A programmal számos előre megtervezett elrendezésű HTML kimenet mellett PDF, vagy akár CHM állományokat is készíthetünk. A Documentor használatához nem lesz szükségünk parancssorra, különböző bűvös utasításokra, bonyolult konfigurációs állományokra, hanem csupán csak a docBuilder eszközre. Ez a képen látható webfelületű egyszerű kezelőprogram, amit nem kell sokat keresnünk, hisz a csomag része. A telepítés során semmi más teendőm nem volt, mint a PHPDocumentor-t egy könyvtárba másolni és a docBuilder-t elindítani.