Home >Backend Development >PHP Tutorial >Learning PHP--Using PhpDocumentor 2 to generate API documentation_PHP tutorial

Learning PHP--Using PhpDocumentor 2 to generate API documentation_PHP tutorial

WBOY
WBOYOriginal
2016-07-13 10:29:28816browse

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 additional ones (such as @link).
  • Faster processing speed. Compared with phpDocumentor 1 under Zend Framework, the processing time 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 parsing. 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%.
  • Easy to create templates, just 1 small step and 3 files to edit.
  • 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 (enabled by default from PHP 5.0.0 version onwards)
  • 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 :

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:

pear <span>install</span> 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

pear channel-discover pear.phpdoc.org <span>//</span><span>注册channel</span>
pear remote-list -c phpdoc <span>//</span><span>列出可以获得的版本</span>
pear <span>install</span> phpdoc/phpDocumentor <span>//</span><span>安装phpDocumentor </span>

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

Installation steps completed!

Prompt:

The installed directories of the two 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:

phpdoc -d 项目绝对路径 -t 生成的文档存放的路径
d represents the path directory, and t represents the 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:

phpdoc -d E:\bak\video\code -t E:\bak\video\code\doc

E:bakvideocode is the folder of php code

E:bakvideocodedoc is the folder where the document is generated

The specific parameters are 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[="..."]]

www.bkjia.comtruehttp: //www.bkjia.com/PHPjc/775953.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...
Statement:
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn