PHP Documentation Tools

Source: Internet
Author: User
Tags documentation pear
Writing a document is a tedious task that you have to do, and writing API-level documentation means a lot of repetitive work and hard to maintain consistency. What we recommend here is a document tool--phpdocumentor that supports PHP5 parsing.
The use of Phpdocumentor not only automatically extracts functions and method definitions from the code, but also automatically processes the relationships between each class and generates class tree accordingly. You can also choose to generate HTML, CHM, or PDF of the document. With Phpdocumentor, document work has become much easier.

Install Phpdocumentor
Installing Phpdocumentor under Pear is an extremely simple thing to do simply by following the CD in the cmd window to the PHP installation directory and entering
Pear Install Phpdocumentor

Pear will download and complete the Phpdocumentor installation on its own.
After Phpdocumentor successfully installed, the PHP installation directory will be more than a phpdoc.bat. This file is the batch file we used to generate the document.
? Related Knowledge?>

Phpdocumentor is an upgraded version of Phpdoc, a document tool that is specifically rewritten to support PHP5 syntax, and when your PHP version is 5 o'clock, run Phpdoc.bat, it automatically invokes Phpdocumentor. So the Phpdoc and Phpdocumentor mentioned in the article are actually the same.


In the directory where Phpdoc.bat is located, enter
Phpdoc

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.