PHP文档工具

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

PHP文档工具<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

——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。这个文件就是我们用来生成文档的批处理文件了。

<? 相关知识 ?>

<?xml:namespace prefix = v ns = "urn:schemas-microsoft-com:vml" /><?xml:namespace prefix = w ns = "urn:schemas-microsoft-com:office:word" />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/PHPUnit<?xml:namespace prefix = st1 ns = "urn:schemas-microsoft-com:office:smarttags" />2” -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

 

VB程序员的FTP编程指南1.3-列出、改变目录

 专 题:列出、改变目录主 讲:qianqian列出目录你可以使用DIR命令来列出目录。实际上,DIR并不是FTP规定的命令,但是标准的用户界面从操作系统借用了这个命令。图2 显示了DIR命令的结果。...
  • qianqian
  • qianqian
  • 2001-12-06 09:37:00
  • 1242

php自写api文档生成工具

框架改版后的第二个版本定下来了,这两天也比较轻松,于是就折腾给项目建个好看的api文档。 各种折腾。先是折腾phpDocumentor2,用phpdoc开源工具来建立文档,好不容易安装成功,各个模板都...
  • qq_21682469
  • qq_21682469
  • 2017-08-10 22:37:08
  • 263

phpDocumentor 制作api文档(一)

一、 什么是phpDocumentorphpDocumentor是PEAR下面的一个非常优秀的模块,它的目标是实现类似javadoc的功能,可以为你的代码快速生成具有相互参照,索引等功能的API文档。...
  • chenshao8818
  • chenshao8818
  • 2009-07-08 16:16:00
  • 732

PHP文档工具

PHP文档工具——phpDocumentorEasy@phpe / 文 写文档是一项乏味却不得不做的工作,而编写API级的文档更是意味着大量的重复劳动和难以保持的一致性。这里我们要推荐给大家的,是支持...
  • Shimizu
  • Shimizu
  • 2004-08-06 13:40:00
  • 8424

php文档工具与版本控制

概述:  php文档工具 phpdocumentor          版本控制(CVS、subversion)相关文章: ...
  • kls2004
  • kls2004
  • 2007-01-15 08:44:00
  • 766

<em>PHP</em> 自动生成帮助<em>文档工具</em>1.0Beta版

<em>PHP</em> 自动生成帮助<em>文档工具</em>1.0Beta版,欢迎大家测试使用。这是写的第一个版本,以后会继续更新。文件说明:do.<em>php</em>程序处理函数。extFunction.<em>php</em>扩展函数,<em>php</em>doc.<em>php</em>...
  • 2018年04月13日 00:00

<em>php</em>5中文帮助<em>文档</em>

2009-10-28 上传大小:5.71MB <em>PHP</em>chm帮助<em>文档</em> 第一个 <em>PHP</em> 页面在 web 服务...如果希望用以上这些<em>工具</em>的某一种来处理脚本,必须保证将结果存成了纯文本格式,...
  • 2018年04月14日 00:00

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

PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc,从1.3.0开始,更名为phpDocumen...
  • ltx851201
  • ltx851201
  • 2010-08-18 13:45:00
  • 7554

使用phpdoc/phpDocumentor来生成api文档

使用phpdoc/phpDocumentor来生成api文档
  • wuchengzeng
  • wuchengzeng
  • 2015-04-27 13:10:05
  • 4944

PHP文档工具-phpDocumentor

PHP文档工具——phpDocumentor 写文档是一项乏味却不得不做的工作,而编写API级的文档更是意味着大量的重复劳动和难以保持的一致性。这里我们要推荐给大家的,是支持PHP5语法分析的文档工具...
  • phper_lon
  • phper_lon
  • 2009-07-06 10:25:00
  • 590
收藏助手
不良信息举报
您举报文章:PHP文档工具
举报原因:
原因补充:

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