phpDocumentor

phpDocumentor
Basisdaten

EntwicklerJoshua Eichorn, Greg Beaver u. a.
Aktuelle Version2.9.0[1]
(22. Mai 2016)
BetriebssystemPlattformunabhängig
ProgrammierspracheJavaScript[2]
KategorieSoftware-Dokumentationswerkzeug
LizenzLGPL
phpdoc.org

phpDocumentor ist ein Software-Dokumentationswerkzeug für PHP. Es steht als freie Software unter der GNU Lesser General Public License. Mit der Software können Entwicklerdokumentationen aus PHP-Quelltexten generiert werden. Für diesen Zweck gilt phpDocumentor als Standardlösung.[3][4] Das Programm kann als eigenständige Software installiert werden und ist fester Bestandteil des PHP Extension and Application Repository (PEAR).[5]

Funktionen

Wie in anderen Software-Dokumentationswerkzeugen wird die Dokumentation durch spezielle Kommentare im Quelltext erfasst, zusätzlich wird die Struktur des Codes analysiert. Über Formatierungsanweisungen in den Kommentaren des Quelltextes können beispielsweise die Anzahl und der Typ von Parametern einer bestimmten Methode sowie deren Aufgabe und Rückgabewert dokumentiert werden.[3] Die Kommentare basieren auf PHPDoc, einer Adaption von Javadoc[6], dem sogenannten PHPDoc Standard. phpDocumentor wurde in PHP geschrieben und erstellt Dokumentationen in einer Vielzahl von Formaten wie HTML, PDF, CHM oder DocBook. phpDocumentor kann sowohl auf der Kommandozeile wie auch über ein Web-GUI bedient werden. phpDocumentor kennt sämtliche syntaktischen Elemente von PHP, es unterstützt sowohl PHP4 wie PHP5. Voraussetzung für die Nutzung der Software ist die Installation von PHP 4.3 oder höher.[7]

phpDocumentor unterstützt keine Spracheigenschaften von PHP, die mit PHP 5.3 eingeführt wurden (z. B. Namespaces). Es wird zurzeit nicht mehr aktiv weiterentwickelt (Stand November 2010).[8] Am 16. März 2012 erschien der Nachfolger phpDocumentor 2, welcher aus einem Zusammenschluss mit DocBlox entstand.[9]

Ähnliche Werkzeuge

Literatur

  • Andi Gutmans: PHP 5 aus erster Hand. 1. Auflage. Addison-Wesley Verlag, 2005, ISBN 978-3-8273-2241-8, S. 707–736.

Weblinks

Einzelnachweise

  1. ↑ Release v2.9.0: PHP-7 Syntax support Release Meldung auf GitHub
  2. ↑ The phpdocumentor Open Source Project on Open Hub: Languages Page. In: Open Hub. (abgerufen am 18. Juli 2018).
  3. ↑ a b Markus Scholl: Konzeption und Teilrealisierung eines Seminarabwicklungssystems GRIN Verlag 2007, S. 86 ISBN 978-3-638-67799-8
  4. ↑ Sebastian Bergmann: Professionelle Softwareentwicklung mit PHP 5. dpunkt.verlag, 1. Auflage 2005, Online-Version (Memento des Originals vom 22. Januar 2009 im Internet Archive)  Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.@1@2Vorlage:Webachiv/IABot/professionelle-softwareentwicklung-mit-php5.de aktualisiert am 15. Januar 2009. ISBN 3-89864-229-1
  5. ↑ Carsten Möhrke: PHP PEAR. Galileo Computing. ISBN 3-89842-580-0 online
  6. ↑ George Schlossnagle: Professionelle PHP 5-programmierung. Addison-Wesley Februar 2006, S. 56. ISBN 978-3-8273-2381-1
  7. ↑ Matthias Kannengiesser: Objektorientierte Programmierung mit PHP 5. Franzis Verlag, 1. Auflage April 2007, S. 529 ISBN 978-3-7723-6296-5
  8. ↑ — (Memento des Originals vom 2. April 2012 im Internet Archive)  Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.@1@2Vorlage:Webachiv/IABot/sourceforge.net
  9. ↑ — (Memento des Originals vom 19. März 2012 im Internet Archive)  Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.@1@2Vorlage:Webachiv/IABot/www.docblox-project.org