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

yipeiwu_com7年前PHP代码库

本文讲述了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 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将HTML表格每行每列转为数组实现采集表格数据的方法

本文实例讲述了php将HTML表格每行每列转为数组实现采集表格数据的方法。分享给大家供大家参考。具体如下: 下面的php代码可以将HTML表格的每行每列转为数组,采集表格数据 <...

以文件形式缓存php变量的方法

本文实例讲述了以文件形式缓存php变量的方法。分享给大家供大家参考。具体实现方法如下: <?php /* $cache_set = array( //缓存路径 , 最后...

基于php中使用excel的简单介绍

基于php中使用excel的简单介绍

在工作中需要处理多语言的翻译问题,翻译都是写在excel表格里面。为了处理方便我就保留中文和英文两列。 这样需要将这些数据从excel中取出来,然乎保存在excel的数组中,通过使用循环...

一篇入门的php Class 文章

刚在大略浏览了一下首页更新的那篇有关Class的文章(指PHPE的那篇 http://www.phpe.net/articles/389.shtml ),很不错,建议...

php实现无限级分类实现代码(递归方法)

开始以为这样的功能似乎很难,之前也做过一个百科的东西,其中也涉及到了分类的功能,不过不是无限级的分类,而是简单的实现了固定的三级分类,当时是自己设计的,想在想起来实现方法太土了,其实三级...