mijane Blog

Wie bereits angekündigt, habe ich beschlossen eine Serie zu dem Thema Doc Blocks in PHP zu starten. Als Doc Block System habe ich mir phpDocumentor ausgesucht, da ich hiermit schon länger arbeite und phpDocumentor alles benötigte bereit stellt.

Starten, werde ich logischerweise mit der Installation von phpDocumentor. Die Installation lässt sich wirklich einfach bewerkstelligen und bietet unter anderem eine Installation unter PEAR (so langsam liebe ich PEAR wirklich). Ihr könnt eure Dokumentationen über die Kommandozeile erstellen oder das Webinterface von phpDocumentor benutzen. In den nächsten beiden Blöcke werde ich auf die Erstellung der Dokumentation unter Benutzung der Konsole und danach durch das Webinterface eingehen.

"phpDocumentor installieren" vollständig lesen

Eine Serie zu einem bestimmtem Thema ist doch immer was nettes, so sehe ich das wenigstens. Also habe ich mir vorgenommen hier eine Serie zum Thema Doc Blocks in PHP zu starten.

Als Doc Block Engine habe ich mir phpDocumentor ausgesucht, da ich hiermit schon länger arbeite und ich dieses Tool ohne Einschränkung empfehlen kann. Ein Blick über den Tellerrand kann aber auch nicht schaden, also werden wir uns auch noch ein Paar andere Programme zur Quellcode Dokumentation anschauen. Vielleicht findet sich ja auch jemand der schon mit anderen Systemen wie z.B. Doxygen gearbeitet hat und gerne ein bisschen darüber erzählen möchte. Bei Interesse meldet euch bitte bei mir über das Kontakt - Formular oder über meine E - Mail Adresse aus dem Impressum.

Starten wir werden mit der Installation von phpDocumentor unter PEAR und als Web Interface. Danach gibt es eine kleine Einführung wie ihr den phpDocumentor auf der Kommandozeile ausführen könnt. Natürlich darf auch ein Einblick in die ganzen Doc Block Parameter nicht fehlen, die ich hier im Kommentar schon Angekündigt habe. Darauf wird eine kleine Session zu dem Thema Doc Block Formatierungen folgen, wo vielleicht auch einige von den erfahreneren Leser noch ein Paar neue Sachen kennen lernen können.

Ich glaube dass das ein ganz interessantes Thema werden wird. Ich persönlich freue mich schon darauf.