phpDocumentor

from Wikipedia, the free encyclopedia
phpDocumentor
Basic data

developer Joshua Eichorn, Greg Beaver et al. a.
Current  version 2.9.0
(May 22, 2016)
operating system Platform independent
programming language JavaScript
category Software documentation tool
License LGPL
phpdoc.org

phpDocumentor is a software documentation tool for PHP . It is available as free software under the GNU Lesser General Public License . The software can be used to generate developer documentation from PHP source code. For this purpose, phpDocumentor is the standard solution. The program can be installed as standalone software and is an integral part of the PHP Extension and Application Repository (PEAR).

Functions

As in other software documentation tools, the documentation is recorded using special comments in the source text, and the structure of the code is also analyzed. Formatting instructions in the comments of the source text can be used, for example, to document the number and type of parameters of a certain method as well as their task and return value. The comments are based on PHPDoc , an adaptation of Javadoc , the so-called PHPDoc standard. phpDocumentor was written in PHP and creates documentation in a variety of formats such as HTML , PDF , CHM or DocBook . phpDocumentor can be operated both on the command line and via a web GUI . phpDocumentor knows all the syntactic elements of PHP, it supports both PHP4 and PHP5. The installation of PHP 4.3 or higher is required to use the software.

phpDocumentor does not support PHP language features that were introduced in PHP 5.3 (e.g. namespaces). It is currently no longer actively developed (as of November 2010). On March 16, 2012, the successor phpDocumentor 2 appeared , which resulted from a merger with DocBlox .

Similar tools

literature

  • Andi Gutmans: PHP 5 first hand . 1st edition. Addison-Wesley Verlag, 2005, ISBN 978-3-8273-2241-8 , pp. 707-736.

Web links

Individual evidence

  1. ↑ Release v2.9.0: PHP-7 syntax support release message on GitHub
  2. ↑ The phpdocumentor Open Source Project on Open Hub: Languages ​​Page . In: Open Hub . (accessed on July 18, 2018).
  3. ↑ a b Markus Scholl: Conception and partial implementation of a seminar processing system GRIN Verlag 2007, p. 86 ISBN 978-3-638-67799-8
  4. ↑ Sebastian Bergmann: Professional software development with PHP 5. dpunkt.verlag, 1st edition 2005, online version ( Memento of the original from January 22, 2009 in the Internet Archive ) Info: The archive link was inserted automatically and not yet checked. Please check the original and archive link according to the instructions and then remove this notice. updated January 15, 2009. ISBN 3-89864-229-1 @1@ 2Template: Webachiv / IABot / professional-softwareentwicklung-mit-php5.de
  5. ^ Carsten Möhrke: PHP PEAR . Galileo Computing. ISBN 3-89842-580-0 online
  6. ↑ George Schlossnagle: Professional PHP 5 programming . Addison-Wesley February 2006, p. 56. ISBN 978-3-8273-2381-1
  7. ↑ Matthias Kannengiesser: Object-oriented programming with PHP 5 . Franzis Verlag, 1st edition April 2007, p. 529 ISBN 978-3-7723-6296-5
  8. ↑ - ( Memento of the original from April 2, 2012 in the Internet Archive ) Info: The archive link was inserted automatically and has not yet been checked. Please check the original and archive link according to the instructions and then remove this notice. @1@ 2Template: Webachiv / IABot / sourceforge.net
  9. ↑ - ( Memento of the original from March 19, 2012 in the Internet Archive ) Info: The archive link was inserted automatically and has not yet been checked. Please check the original and archive link according to the instructions and then remove this notice. @1@ 2Template: Webachiv / IABot / www.docblox-project.org