php安装phpdoc,phpdocmentor安装使用详解

安装phpDocumentor

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

Pear install phpDocumentor即可。

如果显示 Pear 不是内部或外部命令，也不是可运行的程序或批处理文件。则需要先运行 php文件夹里的 go-pear.bat 文件。直接按回车即可装好。期间需要输入一次y，再按任意键就可以了。

然后我们再进入dos下运行 pear命令

当出现这种错误的时候，是因为分配的内存不够

有以下办法解决：

一、修改php.ini(推荐)

memory_limit = 128M

二、在程序里面添加如下语句

ini_set("memory_limit","128M");

三、在根目录建立.htaccess文件，添加如下内容(注意是这种根目录D:\wamp\php\PEAR\PEAR)

php_value memory_limit 128M

如果还不能解决，就把它改得再大一些。(介绍一个办法建立.htaccess文件，新建一个文本文档，然后在里面写好以上语句，另存为的时候，选择所有文件，然后文件名为：.htaccess 即可)

最后注意的是重启apache服务器。

然后再次重新安装，就可以安装成功了。

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

在phpdoc.bat所在目录下，输入

Phpdoc –h

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

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

-f

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

-d

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

-t

生成的文档的存放路径

-o

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

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

试用phpDocumentor

下面演示一下如何使用phpDocumentor来生成文档。

首先，把我们需要的参数确定下来：

-d

D:\www\demo

-t

D:\docs

-o

HTML:frames:phpedit

根据上边的参数，我们组合出下边的命令：

Phpdoc -d “D:\www\demo” -t “D:\docs” -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：

@author 作者信息

@const 由define定义的常量

@deprecate 不建议使用的API

@global 全局变量

@package 包信息

@param 函数参数

@return 返回值

@see 参考函数

@since 引入时间

@static 静态变量

@var 类成员变量

/**

* @name 名字

* @abstract 申明变量/类/方法

* @access 指明这个变量、类、函数/方法的存取权限

* @author 函数作者的名字和邮箱地址

* @category 组织packages

* @copyright 指明版权信息

* @const 指明常量

* @deprecated 指明不推荐或者是废弃的信息

* @example 示例

* @exclude 指明当前的注释将不进行分析，不出现在文挡中

* @final 指明这是一个最终的类、方法、属性，禁止派生、修改。

* @global 指明在此函数中引用的全局变量

* @include 指明包含的文件的信息

* @link 定义在线连接

* @module 定义归属的模块信息

* @modulegroup 定义归属的模块组

* @package 定义归属的包的信息

* @param 定义函数或者方法的参数信息

* @return 定义函数或者方法的返回信息

* @see 定义需要参考的函数、变量，并加入相应的超级连接。

* @since 指明该api函数或者方法是从哪个版本开始引入的

* @static 指明变量、类、函数是静态的。

* @throws 指明此函数可能抛出的错误异常,极其发生的情况

* @todo 指明应该改进或没有实现的地方

* @var 定义说明变量/属性。

* @version 定义版本信息

*/