phpDoc, getest met Nucleus code

Ik wilde al een langere tijd phpDoc eens uittesten. phpDoc is een programma om broncode van een php project mee te documenteren, in de stijl van javaDoc (voor java ;-)). Omdat ik bovendien de broncode van Nucleus wil doornemen om er in de toekomst mee aan te werken, heb ik beiden dus maar ineens gecombineerd.
Het resultaat daarvan vind je hier en een downloadbare tar.gz hier

Het gebruik van phpDoc is eigenlijk vrij eenvoudig, zeker voor mensen die javadoc een beetje kennen. In de broncode zet je op de plaatsen waar je documentatie wilt toevoegen speciale commentaar blokken tussen /* (twee sterrekes) en / Daartussen zet je een uitleg over de class, function, ... en kan je ook verschillende @-regels zetten. Een kort voorbeeldje:

<?php
/**
 * mijn klasse
 * @author TeRaneX
 * @version 0.1
 */
class FooBar()
{
    /**
     * een method die niets zinnings doet :-)
     * @return string
     */
    function doSomthing()
    {
      return 'hello world!';
    }
}