phpDocumentor
Siirry navigaatioon
Siirry hakuun
phpDocumentor on LGPL-lisenssillä julkaistava dokumentointityökalu. phpDocumentor on javadocin kaltainen, PHP:llä luotu dokumentoija, jonka avulla PHP:n lähdekoodista voidaan lukea ja generoida kommenttien dokumentaatio.
phpDocumentor tukee sekä oliopohjaista että proseduraalisella koodilla varustettua lähdekoodia, ja työkalun avulla voidaan julkaista dokumentti HTML-, PDF-, CHM- ja DocBook-muodossa. phpDocumentor osaa linkittää eri dokumentin alueiden välillä yhdistäen näin erilliset dokumentit yhdeksi dokumenttikokonaisuudeksi luoden samalla tarvittavat viittaukset PHP:n perusdokumentaatioon.
phpDocumentoria varten luotu kommenttilohko voisi näyttää esimerkiksi seuraavalta:
/** * Bar-apuluokka luokalle Foo * * Bar-apuluokka lisää luokalle Foo toiminnon Baz * * @see Foo * @todo Tehosta Baz toimintaa */
Aiheesta muualla[muokkaa | muokkaa wikitekstiä]
- phpDocumentor (englanniksi)