PhpDocumentor

PhpDocumentor
phpDocumentor
Entwickler Joshua Eichorn, Greg Beaver u.a.
Aktuelle Version 1.4.3
(5. September 2009)
Betriebssystem Plattformunabhängig
Kategorie Software-Dokumentationswerkzeug
Lizenz LGPL
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.[1][2] Das Programm kann als eigenständige Software installiert werden und ist fester Bestandteil des PHP Extension and Application Repository (PEAR).[3]

Inhaltsverzeichnis

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.[1] Die Kommentare basieren auf einer Adaption von JavaDoc[4], 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.[5]

phpDocumentor unterstützt keine Spracheigenschaften von PHP, die mit PHP 5.3 eingeführt wurden (z.B. Namespaces). Es wird zur Zeit nicht mehr aktiv weiterentwickelt (Stand November 2010).[6]

Ähnliche Werkzeuge

Weblinks

Literatur

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

Einzelnachweise

  1. a b Markus Scholl: Konzeption und Teilrealisierung eines Seminarabwicklungssystems GRIN Verlag 2007, S. 86 ISBN 978-3-638-67799-8
  2. Sebastian Bergmann:Professionelle Softwareentwicklung mit PHP 5. dpunkt.verlag, 1. Auflage 2005, Online-Version aktualisiert am 15. Januar 2009. ISBN 3-89864-229-1
  3. [Carsten Möhrke: PHP PEAR. Galileo Computing. ISBN 3-89842-580-0 http://docs.cojobo.net/galileocomputing/php_pear/22_0_tools_and_utilities-002.htm]
  4. George Schlossnagle: Professionelle PHP 5-programmierung. Addison-Wesley Februar 2006, S. 56. ISBN 978-3-8273-2381-1
  5. Matthias Kannengiesser: Objektorientierte Programmierung mit PHP 5. Franzis Verlag, 1. Auflage April 2007, S. 529 ISBN 978-3-7723-6296-5
  6. http://sourceforge.net/projects/phpdocu/forums/forum/35064

Wikimedia Foundation.

Игры ⚽ Нужен реферат?

Schlagen Sie auch in anderen Wörterbüchern nach:

  • PhpDocumentor — Логотип phpDocumentor Тип Генератор документации Разработчик Joshua Eichorn ОС кроссплатформенная …   Википедия

  • phpDocumentor — Тип Генератор документации Разработчик Joshua Eichorn Операционная система кроссплатформенная Последняя версия 1.4.2 (31.03.2008[1]) Лицензия LGPL …   Википедия

  • Phpdocumentor — est un outil de documentation écrit en PHP. Il est semblable à l outil de javadoc. Il est sous licence LGPL. Il permet d aider les développeurs à la documentation de leur code. Il analyse les commentaires de leurs codes. L outil sait générer de… …   Wikipédia en Français

  • PhpDocumentor — Développeur Auteurs Système d exploitation Multiplate forme Licence …   Wikipédia en Français

  • PhpDocumentor — Infobox Software name = phpDocumentor caption = The phpDocumentor logo website = [http://www.phpdoc.org phpDocumentor] latest release version = 1.4.2 latest release date = March 31, 2008 license = GNU Lesser General Public License platform =… …   Wikipedia

  • PHPDoc — is an adaptation of Javadoc for the PHP programming language. It is a formal standard for commenting PHP code. It offers three main advantages to generic or random commenting styles: First, it makes comments readable in a standard method… …   Wikipedia

  • Comparison of documentation generators — The following tables compare general and technical information for a number of documentation generators. Please see the individual products articles for further information. This article is not all inclusive or necessarily up to date. Unless… …   Wikipedia

  • Anexo:Comparativa de generadores de documentación — Las siguientes tablas comparan información general y técnica de un número de generadores de documentación. Por favor, consulte la página individual de cada producto para obtener información adicional. Este artículo no incluye todos los… …   Wikipedia Español

  • Генератор документации — Генератор документации  программа или пакет программ, позволяющая получать документацию, предназначенную для программистов (документация на API) и/или для конечных пользователей системы, по особым образом комментированному исходному коду и,… …   Википедия

  • DoxyWizard — doxygen Software Dokumentationswerkzeug Basisdaten Entwickler: Dimitri van Heesch Aktuelle Version …   Deutsch Wikipedia

Share the article and excerpts

Direct link
Do a right-click on the link above
and select “Copy Link”