PhpDocumentor 2 installation and how to generate API documentation_PHP tutorial

Official website address: http://www.phpdoc.org/
Project address: https://github.com/phpDocumentor/phpDocumentor2

phpDocumentor 2 is a program that can analyze PHP source code and comment blocks and generate documentation.

Inspired by phpdocumentor 1 and javadoc, it continues to innovate using some new technologies and supports new features of php.

Features of phpDocumentor 2:

Compatible with php5.3, fully supports namespaces and closures, etc.
Recognition supports any tag, as well as some appended ones (such as @link).
Faster processing speed. Compared with phpDocumentor 1, the processing time under Zend Framework has been significantly reduced.
Low memory consumption, the memory consumption of small, medium and large projects is less than 20MB, 40MB and 100MB respectively.
Incremental analysis. If you have the structure.xml file obtained by running phpdoc before, the speed of regenerating the document after minor modifications will be increased by 80%.
It’s easy to create a template, just 1 small step and edit 3 files.
Compatible with the 1st generation command line. For example --directory, --file and --target
two-step processing. First generate a structure file. You can format relevant information according to this file and use your own tools to display the information!

Installation requirements:

PHP 5.3.3 or higher
ext/iconv, http://php.net/manual/en/book.iconv.php (from PHP 5.0.0 version onwards, enabled by default)
ext/ intl, http://php.net/manual/en/book.intl.php
The XSL extension, http://www.php.net/manual/en/book.xsl.php (optional, only Used when using xsl templates)
Graphviz (optional, used to generate class diagrams)

Install phpDocumentor 2

1. Depends on pear for installation:

Download pear http://pear.php.net/go-pear.phar

Put go-pear.phar into the PHP directory

Execute the installation command:

Copy code The code is as follows:

php go-pear.phar

The input system will be executed below

Then press Enter all the way to complete the installation

2. Next install the tools used for class relationship drawing:

Copy code The code is as follows:

pear install image_graphviz

Download http://www.graphviz.org/Download_windows.php graphviz-2.38.msi

After installation, pay attention to check whether the path to the bin has been added to the environment variable path,

The following is a very important step: restart the computer, otherwise it will not take effect

3. Install phpDocumentor

Copy code The code is as follows:

pear channel-discover pear.phpdoc.org //Register channel
pear remote -list -c phpdoc //List available versions
pear install phpdoc/phpDocumentor //Install phpDocumentor

For details, please refer to: http://pear.phpdoc.org/

Installation steps completed!

Prompt:

The directories after installation of both software are under pear under PHP:

php/pear/PhpDocumentor
php/pear/Image

Using PhpDocumentor 2

Start generating project documents below:

In the PHP root directory:

Copy code The code is as follows:

phpdoc -d project absolute path -t path where the generated document is stored

d represents the path directory, and t represents target. Or you can choose -f to specify a single file. After setting the path and waiting for a while, you can see the documentation in the target folder.

Example:

Copy code The code is as follows:

phpdoc -d E:bakvideocode -t E:bakvideocodedoc

E:bakvideocode is the folder of php code

E:bakvideocodedoc is the folder where the document is generated

The specific parameters are as follows:

Copy the code The code is as follows:

project:run [-t|--target [="..."]] [-f|--filename[="..."]] [-d|--directory[="..."]] [-e|--extensions[= "..."]] [-i|--ignore[="..."]] [--ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] [--title[="..."]] [--force] [--validate] [--visibility[="..." ]] [--defaultpackagename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--parseprivate] [-c| --config[="..."]]

http://www.bkjia.com/PHPjc/775000.htmlwww.bkjia.comtruehttp: //www.bkjia.com/PHPjc/775000.htmlTechArticleOfficial website address: http://www.phpdoc.org/ Project address: https://github.com/ phpDocumentor/phpDocumentor2 phpDocumentor 2 is a program that can analyze php source code and comment blocks and generate documents...