PhpDocumentor

　　phpDocument是一个通用的生成PHP文档的工具，他本身也是用PHP写的，跟JAVADoc有些相似，但他有不同于PHPDoc,他比PHPDOC要快，而且能够解析的PHP范围更广，他本身包含了11个摸版，并且还能够生成WINDOWS的chm格式，或PDF、XML DocBook等。

     官方地址 http://pear.php.net/package/PhpDocumentor

     下载页面地址 http://pear.php.net/package/PhpDocumentor/download

     参考地址 http://blog.csdn.net/shimizu/archive/2004/08/06/66980.aspx

     首先如果phpDocument能根据PHP程序生成文档，那么PHP的注释必须按照标准格式书写，下面举几个例子；

     完整例子地址如下：http://pear.php.net/package/PhpDocumentor/docs/latest/phpDocumentor/tutorial_sample2.pkg.html

 

简要说明：

• 注释格式（注意 前面是两个**）

　　　　/**

　　　　*  注释内容

　　　　*/

phpDocumentor 本身已经是 pear 的成员之一，所以安装的时候只要用 pear 来安装即可（以下范例为在 Windows 下进行，以后再补上 LInux 下的）

--如果你已经有装 php 跟 pear 请跳过--

首先假设我把我的的 php 安装路径在 d:\php\

也就是说我从 www.php.net 下载了最新的 php win32 安装档案，解开后放在 d:\php\

那么这个目录下面应该有 d:\php\PEAR这个目录，但是当你进去看的时候，你会发现好像没有 PEAR 相关程序库阿...

没错，这个时候你还没有安装 PEAR 请先用 go-pear.php 安装基本 pear 环境。

安装过程：

Quote: phar "C:/wamp/bin/php/php5.3.0/PEAR/go-pear.phar" does not have a  signaturePHP W arning: require_once(phar://go-pear.phar/index.php): failed to open  stream: pha r error: invalid url or non-existent phar  "phar://go-pear.phar/index.php" in C:/ wamp/bin/php/php5.3.0/PEAR/go-pear.phar on line 1236 Warning: require_once(phar://go-pear.phar/index.php): failed to open  stream: pha   r error: invalid url or non-existent phar  "phar://go-pear.phar/index.php" in C:/   wamp/bin/php/php5.3.0/PEAR/go-pear.phar on line 1236   Press any key to continue . . .，

解决方法：

修改go-pear.bat如下：

@ECHO OFF

set PHP_BIN=php.exe  %PHP_BIN% -d phar.require_hash=0 ./PEAR/go-pear.phar   pause

===========================================

方法一： windows xp下安装pear 环境：PHP4.3.10 + Windows XP 安装步骤： 1)  安装前的工作      安装PHP后所产生的文件夹下面有一个go-pear.bat文件      （我的是  C:/PHP/go-pear.bat） 2) 执行installer       双击go-pear.bat，有问答时，全部按“Enter” 3) 追加路径      打开你的php.ini文件，在      ; Paths and Directories ;      下面看一下有没有"include-path="，没有就追加，有的话就加写pear       include-path=".;C:/PHP;C:/PHP/smarty/libs; c/:php/pear" 4) 查看PHP文件夹       除了go-pear.bat文件，又多了pear.bat和PEAR_ENV.reg 5) 注册表的修改       双击PEAR_ENV.reg文件，选择“ok”，即可完成修改 6) 环境参数的自动设定      双击pear.bat文件即可 7)  确认安装成功与否      打开prompt command，输入“pear  list”看安装在文件夹pear（我的是：c/:php/pear）下面library是否都显示出来了    方法二：

－－－－－－－－－－－－－－            安装pear －－－－－－－－－－－－－－ pear是PHP的 扩展和应用程序库，包含了很多有用的类，安装好php5.0后，pear实际上并没有被安装，安装的方法如下：

1.在php目录中双击go-pear.bat。

2) 执行installer       双击go-pear.bat，有问答时，全部按“Enter”

3).然后安装基本包和提示安装成功，就这么简单。

4).打开 windows目录下的php.ini文件，然后查找到如下的地方：

;UNIX: "/path1:/path2"

;include_path = ".:/php/includes" ;

; Windows: "path1;path2"

;include_path = ".;c:php/includes"

把最后一行的注释去掉，然后把后面路径改成你的PEAR路径，例如：

include_path =  ".;c:/php/includes;D:/ApacheGroup/php5/PEAR" 保存PHP.INI，然后重新启动APACHE即 可。

--安使安装 phpDocumentor --

安装 phpDocumentor 的过程也很简单，只要利用 pear.bat 即可！

使用指令如下

d:\php\PEAR\pear.bat install -o PhpDocumentor

当中有多下一个 -o 的参数，意思是要 pear 把相依的套件也一起下载安装。

安装完成后 d:\php\PEAR 下面应该会多一个 phpdoc.bat 的批次档，我们就可以用这个批次档来产生我们的文件。