php文档工具PHP Documentor安装与使用方法


Posted in PHP onJanuary 25, 2016

本文讲述了php文档工具PHP Documentor安装与使用方法。分享给大家供大家参考,具体如下:

PHP Documentor是PEAR下面的一个模块,用来生成文档。PHP Documentor扫描指定目录下面的php源代码,扫描其中的关键字,截取需要分析的注释,然后分析注释中的专用的tag,生成html文件,接着根据已经分析完的类和模块的信息,建立相应的索引,生成html文件。在review代码的时候,有点用处。

一、安装PHP Documentor

首先要先确认一下有没有安装pear库,

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

如果没有安装http://pear.php.net/go-pear,文件另存为一下。命令行下php go-pear.php,就可以安装了。 我是用yum安装的php,安装的时候,pear已经安装了。pear安装好后,我可以通过pear install phpDocumentor来安装phpdoc

[apacheuser@krlcgcms01 ~]$ phpdoc -h 里面会有很多的参数,要生成html文档,有三个参数是够了。

-d 要分析的目录,多个目录用逗号分割
-t 生成的文档的存放路径
-o 输出的文档格式

二、生产文档

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

上面的这句话是说,将/tmp/test/mytest目录下的php文件,生成文档资料放到/tmp/test/doc下面,文档格式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

到存放生成文档的目录中看一下。系统没有装中文字符,所以中文乱码。

通过浏览器来看一下index.html,部分内容如果下

php文档工具PHP Documentor安装与使用方法

PHP Documentor 文档工具

1. 从上图中,我们可以看出,文档中的内容主要是把php文件中的注释标签列出来,相应的文件列出来,看着比较舒服。其他没有什么。

注释标签如下

@author 作者信息
@const 由define定义的常量
@deprecate 不建议使用的API
@global 全局变量
@package 包信息
@param 函数参数
@return返回值
@see 参考函数
@since 引入时间
@static 静态变量
@var 类成员变量

2. 上图中有乱码的,生成的html的编辑是

<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>

把它改成gbk就不会显示乱码的。

希望本文所述对大家PHP程序设计有所帮助。

PHP 相关文章推荐
source.php查看源文件
Dec 09 PHP
PHP学习资料汇总与网址
Mar 16 PHP
使用php实现下载生成某链接快捷方式的解决方法
May 07 PHP
php实现的短网址算法分享
Jun 20 PHP
PHP中的reflection反射机制测试例子
Aug 05 PHP
ThinkPHP模板中数组循环实例
Oct 30 PHP
PHP中error_log()函数的使用方法
Jan 20 PHP
php建立Ftp连接的方法
Mar 07 PHP
PHP实现仿Google分页效果的分页函数
Jul 29 PHP
php微信公众平台开发之获取用户基本信息
Aug 17 PHP
CI(CodeIgniter)框架实现图片上传的方法
Mar 24 PHP
PhpStorm的使用教程(本地运行PHP+远程开发+快捷键)
Mar 26 PHP
PHP代码维护,重构变困难的4种原因分析
Jan 25 #PHP
PHP+apc+ajax实现的ajax_upload上传进度条代码
Jan 25 #PHP
PHP实现的oracle分页函数实例
Jan 25 #PHP
PHP设置头信息及取得返回头信息的方法
Jan 25 #PHP
基于命令行执行带参数的php脚本并取得参数的方法
Jan 25 #PHP
crontab无法执行php的解决方法
Jan 25 #PHP
win7安装php框架Yii的方法
Jan 25 #PHP
You might like
苏联队长,苏联超人蝙蝠侠,这些登场的“山寨”英雄真的很严肃
2020/04/09 欧美动漫
一个程序下载的管理程序(三)
2006/10/09 PHP
PHP IPV6正则表达式验证代码
2010/02/16 PHP
PHP中冒号、endif、endwhile、endfor使用介绍
2010/04/28 PHP
php遍历树的常用方法汇总
2015/06/18 PHP
深入理解PHP中mt_rand()随机数的安全
2017/10/12 PHP
Laravel事件监听器用法实例分析
2019/03/12 PHP
一端时间轮换的广告
2006/06/26 Javascript
Knockoutjs的环境搭建教程
2012/11/26 Javascript
jquery自定义类似$.ajax()的方法实现代码
2013/08/13 Javascript
用javascript删除当前行,添加行(示例代码)
2013/11/25 Javascript
JavaScript中的substr()方法使用详解
2015/06/06 Javascript
浅析JavaScript访问对象属性和方法及区别
2015/11/16 Javascript
jquery自定义插件开发之window的实现过程
2016/05/06 Javascript
js 动态添加元素(div、li、img等)及设置属性的方法
2016/07/19 Javascript
javascript流程控制语句集合
2017/09/18 Javascript
JavaScript实现单击网页任意位置打开新窗口与关闭窗口的方法
2017/09/21 Javascript
jquery写出PC端轮播图实例
2018/01/26 jQuery
JS使用百度地图API自动获取地址和经纬度操作示例
2019/04/16 Javascript
[00:43]魔廷新尊——痛苦女王至宝捆绑包
2020/06/12 DOTA
Python使用htpasswd实现基本认证授权的例子
2014/06/10 Python
Python企业编码生成系统之主程序模块设计详解
2019/07/26 Python
django解决订单并发问题【推荐】
2019/07/31 Python
python实现读取excel文件中所有sheet操作示例
2019/08/09 Python
pycharm双击无响应(打不开问题解决办法)
2020/01/10 Python
英国巧克力贸易公司:Chocolate Trading Company
2017/03/21 全球购物
Kathmandu澳洲户外商店:新西兰户外运动品牌
2017/11/12 全球购物
莫斯科隐形眼镜网上商店:Linzi
2019/07/22 全球购物
影视动画专业个人的自我评价
2013/12/31 职场文书
人力资源部经理助理岗位职责
2014/03/04 职场文书
商业项目策划方案
2014/06/05 职场文书
小学班级口号大全
2015/12/25 职场文书
Pytorch 如何实现LSTM时间序列预测
2021/05/17 Python
实例讲解Python中sys.argv[]的用法
2021/06/03 Python
Python如何识别银行卡卡号?
2021/06/10 Python
redis客户端实现高可用读写分离的方式详解
2021/07/04 Redis