mijane Blog

ein paar interessante Sachen gibt es immer

phpDocumentor installieren

Geschrieben von Peter Rother • Dienstag, 27. Januar 2009 • Kategorie: Doc Blocks

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.



Webinterface:

Ladet euch das Installations Paket hier herunter. Um phpDocumentor zu installieren, müsst ihr die Dateien in ein erreichbares Verzeichnis auf euren Webserver entpacken. Die Verzeichnis Struktur muss dabei erhalten bleiben. Beachtet bitte das PHP in der Version 4.1.0 oder höher vorhanden sein muss. Hier muss ich doch einmal kurz einlenken ... ich hoffe doch mal das niemand mehr eine 4.x Version benutzt. Und das war es auch schon für die Installation der Webinterface Version. Ihr müsst jetzt nur noch das entsprechende Verzeichnis aufrufen und könnt direkt mit dem phpDocumentor starten.

PEAR:

Unter PEAR geht es noch einfacher.

pear install pear/phpdocumentor

Wollt ihr hier auch auf das Webinterface zugreifen können, dann gebt bitte Folgendes in die Kommandozeile ein:

pear config-set data_dir /pfad/zur/index_html/pear

Der obrige Pfad nimmt an das /pfad/zur/index_html/ der Pfad zu der index.html ist, also wie ein Aufruf von

http://localhost/phpDocumentor/index.html euer Pfad müsste hier natürlich noch angepasst werden, je nachdem, wir ihr phpDocumentor aufrufen wollt.

Und so führt ihr ein Update auf die aktuellste Version durch (die ist beim Schreiben dieses Beitrags 1.4.2 vom 31.03.2008):

pear upgrade PhpDocumentor

Tags für diesen Artikel: , ,
Tweet This!Tweet This!

0 Trackbacks

  1. Keine Trackbacks

0 Kommentare

Ansicht der Kommentare: (Linear | Verschachtelt)
  1. Noch keine Kommentare

Kommentar schreiben


Umschließende Sterne heben ein Wort hervor (*wort*), per _wort_ kann ein Wort unterstrichen werden.
Standard-Text Smilies wie :-) und ;-) werden zu Bildern konvertiert.

Um maschinelle und automatische Übertragung von Spamkommentaren zu verhindern, bitte die Zeichenfolge im dargestellten Bild in der Eingabemaske eintragen. Nur wenn die Zeichenfolge richtig eingegeben wurde, kann der Kommentar angenommen werden. Bitte beachten Sie, dass Ihr Browser Cookies unterstützen muss um dieses Verfahren anzuwenden.
CAPTCHA


Kommentare werden erst nach redaktioneller Prüfung freigeschaltet!