您的位置：首页 > 编程技术 > php  >  php文档工具PHP Documentor安装与使用方法

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

 更新时间：2016年1月26日 10:01  点击：1854

本文讲述了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程序设计有所帮助。

[!--infotagslink--]

相关文章

  • 源码分析系列之json_encode()如何转化一个对象

    这篇文章主要介绍了源码分析系列之json_encode()如何转化一个对象，对json_encode()感兴趣的同学，可以参考下...2021-04-22

  • php中去除文字内容中所有html代码

    PHP去除html、css样式、js格式的方法很多，但发现，它们基本都有一个弊端：空格往往清除不了 经过不断的研究，最终找到了一个理想的去除html包括空格css样式、js 的PHP函数。...2013-08-02

  • index.php怎么打开?如何打开index.php?

    index.php怎么打开?初学者可能不知道如何打开index.php，不会的同学可以参考一下本篇教程 打开编辑：右键->打开方式->经文本方式打开打开运行：首先你要有个支持运行PH...2017-07-06

  • PHP中func_get_args(),func_get_arg(),func_num_args()的区别

    复制代码 代码如下:<?php function jb51(){ print_r(func_get_args()); echo "<br>"; echo func_get_arg(1); echo "<br>"; echo func_num_args(); } jb51("www","j...2013-10-04

  • PHP编程 SSO详细介绍及简单实例

    这篇文章主要介绍了PHP编程 SSO详细介绍及简单实例的相关资料,这里介绍了三种模式跨子域单点登陆、完全跨单点域登陆、站群共享身份认证,需要的朋友可以参考下...2017-01-25

  • PHP实现创建以太坊钱包转账等功能

    这篇文章主要介绍了PHP实现创建以太坊钱包转账等功能，对以太坊感兴趣的同学，可以参考下...2021-04-20

  • php微信公众账号开发之五个坑（二）

    这篇文章主要为大家详细介绍了php微信公众账号开发之五个坑,具有一定的参考价值，感兴趣的小伙伴们可以参考一下...2016-10-02

  • ThinkPHP使用心得分享-ThinkPHP + Ajax 实现2级联动下拉菜单

    首先是数据库的设计。分类表叫cate.我做的是分类数据的二级联动，数据需要的字段有：id,name(中文名),pid(父id). 父id的设置: 若数据没有上一级，则父id为0，若有上级，则父id为上一级的id。数据库有内容后，就可以开始写代码，进...2014-05-31

  • PHP如何通过date() 函数格式化显示时间

    这篇文章主要介绍了PHP如何通过date() 函数格式化显示时间,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-11-13

  • PHP+jQuery+Ajax实现多图片上传效果

    今天我给大家分享的是在不刷新页面的前提下，使用PHP+jQuery+Ajax实现多图片上传的效果。用户只需要点击选择要上传的图片，然后图片自动上传到服务器上并展示在页面上。...2015-03-15

  • golang与php实现计算两个经纬度之间距离的方法

    这篇文章主要介绍了golang与php实现计算两个经纬度之间距离的方法,结合实例形式对比分析了Go语言与php进行经纬度计算的相关数学运算技巧,需要的朋友可以参考下...2016-07-29

  • PHP如何使用cURL实现Get和Post请求

    这篇文章主要介绍了PHP如何使用cURL实现Get和Post请求,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-11

  • 谈谈PHP中相对路径的问题与绝对路径的使用

    经常看到有人踩在了PHP路径的坑上面了，感觉有必要来说说PHP中相对路径的一些坑，以及PHP中绝对路径的使用，下面一起来看看。 ...2016-08-24

  • thinkPHP中多维数组的遍历方法

    这篇文章主要介绍了thinkPHP中多维数组的遍历方法,以简单实例形式分析了thinkPHP中foreach语句的使用技巧,需要的朋友可以参考下...2016-01-12

  • PHP正则表达式过滤html标签属性(DEMO)

    这篇文章主要介绍了PHP正则表达式过滤html标签属性的相关内容，实用性非常，感兴趣的朋友参考下吧...2016-05-06

  • php构造方法中析构方法在继承中的表现

    这篇文章主要为大家详细介绍了php构造方法中析构方法在继承中的表现，感兴趣的小伙伴们可以参考一下...2016-04-15

  • jQuery+PHP+MySQL实现无限级联下拉框效果

    这篇文章主要介绍了jQuery+PHP+MySQL实现无限级联效果的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下...2016-02-21

  • php图片添加文字水印实现代码

    这篇文章主要为大家详细介绍了php图片添加文字水印实现代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下...2016-03-17

  • php有序列表或数组中删除指定的值的实现代码

    这篇文章主要介绍了php有序列表或数组中删除指定的值的实现代码,删除给定的值之后，得到一个新的有序列表，长度-1，下面是具体的实现方法...2021-08-22

  • PHP简单实现生成txt文件到指定目录的方法

    这篇文章主要介绍了PHP简单实现生成txt文件到指定目录的方法,简单对比分析了PHP中fwrite及file_put_contents等函数的使用方法,需要的朋友可以参考下...2016-04-28