PHP文档工具

原创 2004年08月06日 13:40:00

PHP文档工具

——phpDocumentor

Easy@phpe /

 

写文档是一项乏味却不得不做的工作,而编写API级的文档更是意味着大量的重复劳动和难以保持的一致性。这里我们要推荐给大家的,是支持PHP5语法分析的文档工具——phpDocumentor

使用phpDocumentor不仅可以自动从代码中提取出函数和方法定义,还可以自动处理各个class之间的关系,并据此生成class tree。你还可以选择将文档生成htmlchm或者pdf。有了phpDocumentor,文档工作变得轻松了很多。

 

安装phpDocumentor

pear下安装phpDocumentor是一件极其简单的事情,只需要在cmd窗口中cd php安装目录下,然后输入

Pear install phpDocumentor

Pear就会自己下载并完成phpDocumentor的安装。

phpDocumentor成功安装后,php安装目录下会多出来一个phpdoc.bat。这个文件就是我们用来生成文档的批处理文件了。

<? 相关知识 ?>

phpDocumentorphpDoc的升级版本,是专门为支持php5语法而重写的文档工具,当你的php版本为5时,运行phpDoc.bat,它会自动去调用phpDocumentor。所以文章中的提到的phpDocphpDocumentor实际上是相同的。

 

phpdoc.bat所在目录下,输入

Phpdoc –h

会得到一个phpDocumentor的详细参数列表。

我们从其中选出几个常用的来看看:

<? 命令解释 ?>

-f

要进行分析的文件名,多个文件用逗号分割

-d

要分析的目录,多个目录用逗号分割

-t

生成的文档的存放路径

-o

输出的文档格式,结构为输出格式:转换器名:模版目录,例如:HTML:frames:phpedit

 

我们会用到的就这几个了,其他的命令请大家阅读help的提示信息。

 

试用phpDocumentor

  下面我们就以pear中的phpUnit2为例,演示一下如何使用phpDocumentor来生成文档。

  首先,把我们需要的参数确定下来:

<? 命令参数 ?>

-d

C:/Program Files/EasyPHP5/php/PEAR/PHPUnit2

-t

C:/Program Files/EasyPHP5/php/phpunit2doc

-o

HTML:frames:phpedit

根据上边的参数,我们组合出下边的命令:

Phpdoc -d  C:/Program Files/EasyPHP5/php/PEAR/PHPUnit2” -t “C:/Program Files/EasyPHP5/php/phpunit2doc” -o “HTML:frames:phpedit”

运行上边的命令后,phpDocumentor开始解析源文件并输出工作信息。

命令运行完成后,我们的文档就已经生成好了。 进入我们指定的目标目录,用浏览器打开index.html就可以看见生成的文档了。  文档界面由frame分成了三个部分,左上是包信息,左下是导航信息,右边则是详细的信息呈现页。

上边的图很清楚地描述出了文档的内容:

索引、函数列表、类列表、文件列表和子包。

点击上边的class(es)链接,我们可以清晰的看见整个包的class tree

我们点击其中一个class,就进入了class的描述页面。

Class描述页面主要包含以下几方面内容:

 

l          描述:版权、作者、类层次等

l          类变量

l          类常量

l          方法

l          继承的变量

l          继承的方法:非常有用的一个功能

 

 

怎么样,是不是很详细呢?如果要生成chm,可以把前边的-o参数改为”CHM:default: default”,这样phpDocumentor会为你生成好chm项目文件,只要用微软的chm工具进行编译就可以得到可用的chm文件了。

 

phpDocumentor为自己的代码生成文档

  虽然phpDocumentor可以自动从代码中分析出一些信息,但是,要形成一份详尽的文档还是需要我们在编码中进行配合的。为了让phpDocumentor读懂我们的代码,我们需要注意一些编码规范和在注释中增加一些tag

 

<? Tags ?>

@author 

作者信息

@const

define定义的常量

@deprecate

不建议使用的API

@global

全局变量

@package

包信息

@param

函数参数

@return

返回值

@see

参考函数

@since

引入时间

@static

静态变量

@var

类成员变量

 

这里只是简单的列出了常用的一些Tag,大家可以阅读phpDocumentor的文档,里边有非常详细的编码规范。关于phpDocumento就介绍到这里,希望大家都能好好利用这个工具来规范自己的文档。

 

PSphpDocumentor也有Web界面的,你可以访问http://phpdoc.org获取Web版本。Web版本的安装很简单,直接放到web可以访问的目录就可以运行了。

 

<? 环境要求 ?>

PHP5.0.0

OS: 平台独立,本文演示OSwindows

 

php文档说明标签文档说明

java用javadoc生成文档,这个大家都知道,php呢?google了一下,发现了PhpDocumentor,网上关于它的文章很多!PhpDocumentor可以通过PEAR获得,PHP Exte...
  • lumengabc
  • lumengabc
  • 2013年12月09日 10:56
  • 868

告别手写 API文档生成工具推荐

随着API的发展以及需求的日益增加,对API文本文档的需求与随之而来。相信许多开发人员都遇到过编写API文档方面的问题及烦恼。 你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工...
  • u011537073
  • u011537073
  • 2017年04月26日 22:38
  • 2547

PHP导出word文档的简单实现方法(可导出图片)

这是看了网上几篇关于PHP导出word文档的文章之后,本人改进一下的方法,可以导出带图片的,以下是demo。 $row = M('Article')->where(array('id...
  • M471586651
  • M471586651
  • 2016年07月23日 17:19
  • 6360

初识DocBook(编写技术文档的工具)

突然在Linux下看到一堆命令
  • xuyunzhang
  • xuyunzhang
  • 2014年05月29日 14:22
  • 1991

有关PHP文档生成工具---PHPDocumentor

1. 什么是phpDocumentor ? PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc,...
  • liuzhushiqiang
  • liuzhushiqiang
  • 2013年03月30日 20:43
  • 968

PhpDocument生成帮助文档使用说明

最近做一个比较大的项目,要求我们写很多的文档,以前就听说过这个东西,但是一直没用。文档太多要写需要花费很长时间,想起来用这个东西来生成文档,今天试了试效果很不错,主要是开发过程中一定要写规范的注释。 ...
  • lumengabc
  • lumengabc
  • 2013年12月09日 10:50
  • 1475

开发文档生成工具----强大的Doxygen工具使用手册

张三:假如我们自己开发了一个类库,怎么做一个方便阅读的文档呢? 李四:一个方法一个方法地写呗,就像写Excel文档一下。 张三:啊,你out了,这多慢呀。为什么不玩玩doxygen工具,它...
  • richie0006
  • richie0006
  • 2016年05月11日 14:13
  • 1780

自己项目中PHP常用工具类大全分享

Php代码    /**   * 助手类   * @author www.shouce.ren   *   */    class Helper    {       ...
  • starsliu
  • starsliu
  • 2016年04月20日 13:28
  • 587

gitbook--好用的编写API文档工具

参考资料:http://gitbook.zhangjikai.com/index.html创建一个gitbook仓库包含基本的文件:.gitignore SUMMARY.md(撰写左边导航栏) R...
  • lintcgirl
  • lintcgirl
  • 2017年01月10日 15:09
  • 5007

PHP生成word并可下载

如下代码,直接输出并可下载
  • leejianjun
  • leejianjun
  • 2016年08月17日 17:22
  • 4453
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:PHP文档工具
举报原因:
原因补充:

(最多只允许输入30个字)