phpdoc

1.安装PEAR

官方网站: http://pear.php.net/

PHP 5.4 的 Windows 包中没有自带 PEAR，下载 http://pear.php.net/go-pear.phar 到PHP目录，并运行:

php go-pear.phar

安装完成后PHP目录下会产生一个名为 pear.bat 的批处理文件，并且会在系统中添加以下环境变量(用户变量，假定PHP安装在C:\php):

PHP_PEAR_BIN_DIR=C:\php

PHP_PEAR_DATA_DIR=C:\php\data

PHP_PEAR_DOC_DIR=C:\php\docs

PHP_PEAR_INSTALL_DIR=C:\php\pear

PHP_PEAR_PHP_BIN=C:\php\php.exe

PHP_PEAR_SYSCONF_DIR=C:\php

PHP_PEAR_TEST_DIR=C:\php\tests

在写使用了 PHP 的批处理脚本时可以好好利用下这些环境变量。

在命令行输入:

pear version

如果有显示类似如下信息，说明 PEAR 已经成功安装：

PEAR Version: 1.9.4

PHP Version: 5.4.4

Zend Engine Version: 2.4.0

Running on: Windows NT ACER-TM4750G 5.1 build 2600 (Windows XP Professional Service Pack 3) i586

2.安装 PHPUnit

官方网站: http://www.phpunit.de/
PHPUnit 3.6 需要 PHP 5.2.7 (或更改版本) 但强烈推荐使用 PHP 5.3.9 (或更高版本)。

PHPUnit 使用PEAR进行安装:

pear config-set auto_discover 1

pear install pear.phpunit.de/PHPUnit

安装完成后PHP目录下会产生一个名为 phpunit.bat 的批处理文件。

在命令行输入:

phpunit --version

如果有显示类似如下信息，说明 PHPUnit 已经成功安装：

PHPUnit 3.6.11 by Sebastian Bergmann.

注意，在 PHP 官方 PEAR 频道上也有两个 PHPUnit 的包，名称分别为 PHPUnit 和 PHPUnit2 ，这两个包都是旧版本，分别是 1.x 和 2.x 的版本，如果你使用下面的方式直接安装：

pear install phpunit

那你安装的就是为 PHP 4.x 提供的旧版本 PHPUnit 1.x 了，要使用最新的 PHPUnit 3.x 版本，你需要使用 pear.phpunit.de 这个频道。

使用PHPUnit:

%PHP_PEAR_BIN_DIR%\phpunit test.php

3.安装 phpDocumentor 2

官方网站: http://www.phpdoc.org/
phpDocumentor 2 是为PHP 5.3 或更高版本的所有特性生成 API 文档而创建。

phpDocumentor 2 同样使用PEAR进行安装:

pear channel-discover pear.phpdoc.org

pear install phpdoc/phpDocumentor-alpha

安装完成后PHP目录下会产生一个名为 phpdoc.bat 的批处理文件。

在命令行输入:

phpdoc --version

如果有显示类似如下信息，说明 phpDocumenter 2 已经成功安装：

phpDocumentor version 2.0.0a7

使用方法，在要生成文档的项目所在目录运行:

%PHP_PEAR_BIN_DIR%\phpdoc -d . -t docs

/**
* @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 定义版本信息
*/