ApiGen für Netbeans: Dokumentieren wie mit phpDocumentor
Kommentare

Zu gutem Code gehört auch eine gute Dokumentation. Viele PHP-Entwickler nahmen dafür lange Zeit phpDoc zur Hilfe, doch dieses Projekt wurde leider vor knapp vier Jahren eingestellt. Mit ApiGen soll

Zu gutem Code gehört auch eine gute Dokumentation. Viele PHP-Entwickler nahmen dafür lange Zeit phpDoc zur Hilfe, doch dieses Projekt wurde leider vor knapp vier Jahren eingestellt. Mit ApiGen soll diese Lücke nun geschlossen werden. Oracle erklärt in seinem Blog, wie man ApiGen in Netbeans integriert.

Um ApiGen via PEAR installieren zu können, müssen dem Repository folgende Einträge hinzugefügt werden:

pear channel-discover pear.apigen.org
pear channel-discover pear.nette.org
pear channel-discover pear.texy.info
pear channel-discover pear.kukulich.cz
pear channel-discover pear.andrewsville.cz  

Anschließend sollte sich das Plug-in wie folgt installieren lassen:

pear install nette/Nette-beta
pear install apigen/ApiGen  

In Netbeans müssen anschließend noch die Pakete verifiziert werden, und zwar unter Tools > Options > PHP > ApiGen. In den Project Properties kann man ApiGen dann nach eigenen Vorlieben konfigurieren oder Konfigurationen im Neon-Format im- bzw. exportieren. Wenn das fertig ist, lässt sich die Doku wie folgt erstellen:

Das Resultat sieht dann in etwa so aus wie in dieser Vorschau aus dem Nella Framework.

Unsere Redaktion empfiehlt:

Relevante Beiträge

Meinungen zu diesem Beitrag

X
- Gib Deinen Standort ein -
- or -