phpdocumentor 学习笔记(一)

本文详细介绍如何使用PHPDoc生成代码注释文档。从安装配置到实际应用案例,一步步引导读者掌握PHPDoc的基本操作。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

phpdocumentor是一款可以生成代码注释文档的插件,用起来及其方便。

我们只要遵守他的注释规则然后生成文档即可。

我这里用的是phpdocumentor1.4.4版本。

首先进行安装,我这里安装的很顺利,用的PHP直接包含了go-pear.phar 没在这个上面多费功夫。

直接使用命令行自动安装。(要使用管理员权限打开命令行)

然后直接进到go-pear.phar所在目录。

pear install phpdocumentor

然后就会自动下载phpdocumentor,我这里自动下载的是1.4.4的版本。(最新已经到2.X了吧)

还可以手动进行安装。(这里没有尝试,可以自行谷歌)

安装成功之后在php目录下输入phpdoc -h 如果弹出帮助页面(命令介绍,都是英文)说明成功。

然后就可以进行操作。

首先准备一个按照注释规则进行注释的文件。

然后输入命令 phpdoc -f 文件位置 -t 生成文件输入位置 -o 输出的模板

例:phpdoc -o HTML:frames:earthli -f D:\lamppr\www\backend\program\core\sql.php -t F:\phpdocumentor\new1

然后打开生成文件的位置点开index即可。

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值