用phpDocumentor来生成文档

26 篇文章 0 订阅
首先是安装
linux下
#pear upgrade PhpDocumentor
或者直接去http://sourceforge.net/projects/phpdocu/files/  下载包(要!翻@墙) ,然后再编译,
编译前确认你的php支持了zlib的话,可以直接
#pear install PhpDocumentor-1.4.4.tgz
#cd PhpDocumentor-1.4.4
#chmod 755 phpdoc
./phpdoc -h

使用很简单
#phpdoc -d /home/www/f404/ -t /home/www/f404/doc/ -ti 'f404doc' -dn 'f404man'
参数说明 -d 后面跟着的是项目所在文件夹
                  -t 后面跟着是你要把文档存在的文件夹
                  -ti   后面是设置项目标题的

                  -dn 后面 是定义默认的包名

如果中文乱码,直接在浏览器里面设置网页编码为utf-8就可以了。或者去生成的doc里面,把表头的iso-8859-1改成utf-8

需要你自己在php文件里面规范的文档参数

@author 作者信息
@const 由define定义的常量
@deprecate 不建议使用的API
@global 全局变量
@package 包
@param 参数
@return 返回
@see 参考,超链接
@link 类似@see.只包含对元素的引用,如@link Command::excute()
@since 引入时间
@static 静态变量
@var 每个类属性类型
@license 许可信息
@lar 每个类属性类型






  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值