How to install and use php document tool PHP Documentor_php tips

This article describes how to install and use the php document tool PHP Documentor. Share it with everyone for your reference, the details are as follows:

PHP Documentor is a module under PEAR, used to generate documents. PHP Documentor scans the PHP source code under the specified directory, scans the keywords, intercepts the comments that need to be analyzed, then analyzes the special tags in the comments, generates HTML files, and then creates corresponding information based on the analyzed classes and modules. Index and generate html files. It is somewhat useful when reviewing code.

1. Install PHP Documentor

First of all, make sure the pear library is installed,

; UNIX: "/path1:/path2" 
include_path = ".:/usr/share/pear" //pear库位置 
; 
; Windows: "\path1;\path2" 
;include_path = ".;c:\php\includes" 

If http://pear.php.net/go-pear is not installed, save the file as. You can install php go-pear.php from the command line. I installed php using yum, and during installation, pear was already installed. After pear is installed, I can install phpdoc through pear install phpDocumentor

[apacheuser@krlcgcms01 ~]$ phpdoc -h There will be many parameters in it. To generate html documents, three parameters are enough.

-d Directory to be analyzed, separate multiple directories with commas
-t Storage path of the generated document
-o Output document format

2. Production documents

Copy code The code is as follows:

[root@krlcgcms01 test]# phpdoc -d "/tmp/test /mytest" -t "/tmp/test/doc" -o "HTML:frames:phpedit"

The above sentence means to generate documentation from the php file in the /tmp/test/mytest directory and put it under /tmp/test/doc, in the format of html.

[apacheuser@krlcgcms01 doc]$ ls
blank.html elementindex.html li_首页.html
classtrees_default.html elementindex_首页.html media
classtrees_首页.html errors.html packages.html
default index.html 首页
elementindex_default.html li_default.html

Go to the directory where the generated documents are stored and take a look. The system does not have Chinese characters installed, so the Chinese characters are garbled.

Take a look at index.html through the browser. If you download some of the content

PHP Documentor Document Tool

1. From the picture above, we can see that the content in the document mainly lists the comment tags in the php file, and the corresponding files are listed, which is more comfortable to look at. Nothing else.

Annotation tags are as follows :

@author Author information
@const Constant defined by define
@deprecate Deprecated API
@global global variable
@package package information
@param function parameter
@return return value
@see reference function
@since introduction time
@static static variable
@var class member variable

2. There are garbled characters in the picture above. The editor of the generated html is

Copy code The code is as follows:

Change it to gbk and it will not display garbled characters.

I hope this article will be helpful to everyone in PHP programming.