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 相关文章推荐
php基础知识:控制结构
Dec 13 PHP
PHP中的array数组类型分析说明
Jul 27 PHP
PHP冒泡排序算法代码详细解读
Jul 17 PHP
phpExcel导出大量数据出现内存溢出错误的解决方法
Feb 28 PHP
Yii PHP Framework实用入门教程(详细介绍)
Jun 18 PHP
一个漂亮的php验证码类(分享)
Aug 06 PHP
php使用strtotime和date函数判断日期是否有效代码分享
Dec 25 PHP
jquery+php+ajax显示上传进度的多图片上传并生成缩略图代码
Oct 15 PHP
PHP实现将textarea的值根据回车换行拆分至数组
Jun 10 PHP
Joomla开启SEF的方法
May 04 PHP
php微信公众号开发之图片回复
Oct 20 PHP
PHP常用函数之根据生日计算年龄功能示例
Oct 21 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
php中curl和file_get_content的区别
2014/05/10 PHP
PHP中的闭包(匿名函数)浅析
2015/02/07 PHP
php中分页及SqlHelper类用法实例
2017/01/12 PHP
PHP时间处理类操作示例
2018/09/05 PHP
php多进程并发编程防止出现僵尸进程的方法分析
2020/02/28 PHP
自动检查并替换文本框内的字符
2006/06/30 Javascript
各种效果的jquery ui(接口)介绍
2008/09/17 Javascript
一个简单的js渐显(fadeIn)渐隐(fadeOut)类
2010/06/19 Javascript
jquery 使用点滴函数代码
2011/05/20 Javascript
元素未显示设置width/height时IE中使用currentStyle获取为auto
2014/05/04 Javascript
node.js中的http.response.end方法使用说明
2014/12/14 Javascript
jQuery中get()方法用法实例
2014/12/27 Javascript
jquery动态添加删除(tr/td)
2015/02/09 Javascript
微信小程序 wx.uploadFile在安卓手机上面the same task is working问题解决
2016/12/14 Javascript
jQuery Password Validation密码验证
2016/12/30 Javascript
简单实现js悬浮导航效果
2017/02/05 Javascript
AngularJS发送异步Get/Post请求方法
2018/08/13 Javascript
微信小程序实现简易table表格
2020/06/19 Javascript
解决layer弹出层msg的文字不显示的问题
2019/09/11 Javascript
浅谈vue 多个变量同时赋相同值互相影响
2020/08/05 Javascript
解决Antd 里面的select 选择框联动触发的问题
2020/10/24 Javascript
简明 Python 基础学习教程
2007/02/08 Python
10个易被忽视但应掌握的Python基本用法
2015/04/01 Python
Python的Django框架中自定义模版标签的示例
2015/07/20 Python
Python代码实现KNN算法
2017/12/20 Python
如何利用python查找电脑文件
2018/04/27 Python
python基础学习之如何对元组各个元素进行命名详解
2018/07/12 Python
使用IPython或Spyder将省略号表示的内容完整输出
2020/04/20 Python
python gui开发——制作抖音无水印视频下载工具(附源码)
2021/02/07 Python
师范应届生教师求职信
2013/11/05 职场文书
酒店总经理工作职责
2013/12/13 职场文书
大学生关于奋斗的演讲稿
2014/01/09 职场文书
幼儿生日活动方案
2014/08/27 职场文书
2014年体育工作总结
2014/11/24 职场文书
汉字听写大会观后感
2015/06/12 职场文书
python实现语音常用度量方法的代码详解
2021/05/25 Python