注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

onefish资料库

成功要素---耐得住孤独!

 
 
 

日志

 
 

php文档工具PHP Documentor  

2011-04-14 13:54:24|  分类: php |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

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

一,安装PHP Documentor

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

查看复制打印?

  1. ; UNIX: "/path1:/path2"  

  2. include_path = ".:/usr/share/pear"  //pear库位置  

  3. ;  

  4. ; Windows: "\path1;\path2"  

  5. ;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 输出的文档格式

二,生产文档

查看复制打印?

  1. [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

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就不会显示乱码的。



  评论这张
 
阅读(74)| 评论(0)
推荐 转载

历史上的今天

在LOFTER的更多文章

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017