phpDocumentor

PhpDocumentor is a software documentation tool for PHP. It is available as free software under the GNU Lesser General Public License. With the software developer documentation can be generated from PHP source code. PhpDocumentor is the standard solution for this purpose. The program can be installed as a stand-alone software and is an integral part of the PHP Extension and Application Repository ( PEAR ).

Functions

As in other software documentation tools, the documentation is captured by special comments in the source code, in addition, the structure of the code is analyzed. About formatting instructions in the comments of the source code, for example, the number and type of parameters of a particular method as well as their task and return value can be documented. 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 including HTML, PDF, CHM or DocBook. phpDocumentor can be operated both on the command line as well as via a web GUI. phpDocumentor knows all the syntactic elements of PHP, it supports both PHP4 as PHP5. A prerequisite for the use of the software to install PHP 4.3 or higher.

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

Similar tools

648448
de