使用phpdoc/phpDocumentor来生成api文档
phpDocumentor是一个非常强大的文档自动生成工具，利用它可以帮助我们编写规范的注释，生成易于理解，结构清晰的文档，
对我们的代码升级，维护,移交等都有非常大的帮助。
网上关于phpdoc的文档的介绍虽然不少，但是有点麻烦：
1、网上通常介绍的内容太多，不容易被新手看懂。个人觉得，教程应该本着简单易懂，在能解决问题的前提下，能有多简单就多简单。
更多的内容，应该以附录的形式，或者留下其他更详细的资料链接供读者去阅读（而不是把一大块都复制进自己的文章）
2、phpdoc的安装稍微麻烦。他们没有介绍一种简单易上手的方法给读者
3、phpdoc的默认编码是ISO-8859-1，此时生成的HTML文档会中文乱码。尽管说网上有提供了解决方案??但是，为什么不直接提供一个可支持中文的版本给读者呢？
基于以上几点，我想写篇博文，跟大家分享一个使用phpdoc的简单方法(windows环境下)
在使用phpdoc之前，你首先需要了解代码注释的语法规则（如果你已经懂，请忽略）。
可参考维基本科 http://zh.wikipedia.org/wiki/PHPDoc 中关于注释格式的描述部分。
接着，可下载这个经过优化的phpdoc版本:
http://star7th-wordpress.stor.sinaapp.com/uploads/2013/04/phpdoc.zip
下载后解压，比如说解压到”D:/phpdoc”路径下。
用文本编辑器打开phpdoc.bat（注意，不是双击运行），第16行：
SET phpCli=D:\Program Files\php5.3.11\php.exe
将这里的PHP.exe的路径改为你电脑的php环境执行文件所在的路径。（如果你是PHPer，我相信你在本机有安装了php环境吧。）
然后，打开命令提示符。（开始-运行-cmd），在命令行中，进入phpdoc所在的目录，（比如说，输入“cd D:/phpdoc”）。
进入目录后，输入下面的命令，便可快速生成HTML文档：
phpdoc -d D:\website\Api -t D:\website\Api\doc -dn shilianwang -dc shilianwang -ti 事联网文档 -o HTML:Smarty:PHP
上述命令中，D:\website\Api是源php文件所在目录。D:\website\Api\doc 是生成的文档存放目录。
shilianwang是子目录，包、标题。HTML:Smarty:PHP 表示使用HTML模块生成
上面的命令，如果你想详细了解，可在命令行输入phpdoc -h ，了解更多。
最后，附上三种效果图：
注释的样式：
该注释生成的效果图：
PhpDocumentor手册-安装和标签使用
谢谢关注websites博客!
Hot AI Tools
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Undress AI Tool
Undress images for free
Clothoff.io
AI clothes remover
AI Hentai Generator
Generate AI Hentai for free.
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
Hot Topics
Working with Flash Session Data in Laravel
Mar 12, 2025 pm 05:08 PM
Laravel simplifies handling temporary session data using its intuitive flash methods. This is perfect for displaying brief messages, alerts, or notifications within your application. Data persists only for the subsequent request by default: $request-
cURL in PHP: How to Use the PHP cURL Extension in REST APIs
Mar 14, 2025 am 11:42 AM
The PHP Client URL (cURL) extension is a powerful tool for developers, enabling seamless interaction with remote servers and REST APIs. By leveraging libcurl, a well-respected multi-protocol file transfer library, PHP cURL facilitates efficient execution of various network protocols, including HTTP, HTTPS, and FTP. This extension offers granular control over HTTP requests, supports multiple concurrent operations, and provides built-in security features.
Simplified HTTP Response Mocking in Laravel Tests
Mar 12, 2025 pm 05:09 PM
Laravel provides concise HTTP response simulation syntax, simplifying HTTP interaction testing. This approach significantly reduces code redundancy while making your test simulation more intuitive. The basic implementation provides a variety of response type shortcuts: use Illuminate\Support\Facades\Http; Http::fake([ 'google.com' => 'Hello World', 'github.com' => ['foo' => 'bar'], 'forge.laravel.com' =>
12 Best PHP Chat Scripts on CodeCanyon
Mar 13, 2025 pm 12:08 PM
Do you want to provide real-time, instant solutions to your customers' most pressing problems? Live chat lets you have real-time conversations with customers and resolve their problems instantly. It allows you to provide faster service to your custom
Explain the concept of late static binding in PHP.
Mar 21, 2025 pm 01:33 PM
Article discusses late static binding (LSB) in PHP, introduced in PHP 5.3, allowing runtime resolution of static method calls for more flexible inheritance.Main issue: LSB vs. traditional polymorphism; LSB's practical applications and potential perfo
PHP Logging: Best Practices for PHP Log Analysis
Mar 10, 2025 pm 02:32 PM
PHP logging is essential for monitoring and debugging web applications, as well as capturing critical events, errors, and runtime behavior. It provides valuable insights into system performance, helps identify issues, and supports faster troubleshoot
HTTP Method Verification in Laravel
Mar 05, 2025 pm 04:14 PM
Laravel simplifies HTTP verb handling in incoming requests, streamlining diverse operation management within your applications. The method() and isMethod() methods efficiently identify and validate request types. This feature is crucial for building
Discover File Downloads in Laravel with Storage::download
Mar 06, 2025 am 02:22 AM
The Storage::download method of the Laravel framework provides a concise API for safely handling file downloads while managing abstractions of file storage. Here is an example of using Storage::download() in the example controller:
