PhpDocumentor简介
PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便。
参考介绍:
百度百科:http://baike.baidu.com/view/1269751.htm
维基百科:http://en.wikipedia.org/wiki/Phpdoc http://en.wikipedia.org/wiki/PhpDocumentor
官网:http://www.phpdoc.org/
手册文档:http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html
本机环境介绍:
wamp集成环境,php版本5.2.11
安装目录:E:\wamp\bin\php\php5.2.11
php.exe和php.ini.所在目录:E:\wamp\bin\php\php5.2.11
1、确认wamp环境能正常运行。
2、开始 -> 运行 -> 输入cmd回车,切换到php.exe所在目录
3、输入 go-pear.bat
这里脚本会询问我们是否是选择服务器范围,还是本地拷贝,我们选择系统。默认就是选择系统,直接回车。
4、这里会列出pear路径配置,询问我们是否修改。回车接受,开始安装pear库。
5、安装过程中,会提示我们修改php.ihi设置inclue_path,输入“y"回车继续安装。
注意:这里安装脚本设置的是自动修改php.ini设置include_path,就我观察,输入“Y”回车,php.ini并没有修改成功,这里为了保险,我们可以自己人肉确认一遍include_path是否设置正确。
6、安装完成,提示我们导入pear环境变量注册表文件:E:\wamp\bin\php\php5.2.11\PEAR_ENV.reg,我们找到该文件,双击导入注册表。回车结束安装。该文件起设置pear环境变量的作用。
7、输入pear,确认pear是否成功安装,如果出现以下界面,就表示pear已经安装成功。
8、安装PhpDocumentor前的一些准备,升级pear,可能我们安装的pear版本会有点老,故这里要升级pear。
输入:
pear upgrade pear
等升级完成,安装PhpDocumentor依赖包。
输入:
pear install XML_Parser
pear install XML_Beautifier
9、安装PhpDocumentor
输入:
pear install PhpDocumentor
注意:这里由于网络原因,下载安装很可能会失败,或者等很长时间后安装失败,可以直接上官网下载压缩包,回来安装。记得是下后缀名是“tgz”的压缩包
长宽或光纤网络安装毫无压力
下载路径:http://sourceforge.net/projects/phpdocu/files/PhpDoc/phpDocumentor-1.4.3/PhpDocumentor-1.4.3.tgz/download
这里出现了一个小插曲,明明是.tgz的,下载到本地就是.gz的。无奈只好手动改名文件为.tgz后缀。拷贝至php.exe同级目录下。折腾尝试了半天算是弄明白了这么本地安装。
pear help
得到pear命令帮助
pear help install
得到install帮助
言归正传,输入:
pear install PhpDocumentor-1.4.3.tgz
提示安装成功
10、输入 phpdoc -h,得到下图所示,就表示安装成功了。
分享到:
相关推荐
### PHP5.4.3 下安装 PEAR、PHPUnit 和 phpDocumentor2 #### 一、安装 PEAR 在 PHP5.4.3 及以上版本中安装 PEAR 的过程相对简单,但需确保 PHP 环境配置正确。以下是安装步骤: 1. **下载 go-pear.phar 文件** ...
通过这个例子,我们可以看到如何使用PHPDoc注释来描述类、属性和方法,以及如何在phpDocumentor的帮助下,将这些注释转换为易于阅读的API文档。 在实际项目中,遵循良好的文档编写习惯对于代码的可维护性和团队协作...
phpDocumentor可以通过PEAR(PHP Extension and Application Repository)进行安装,或者直接下载其源码包进行手动安装。在PEAR中,可以使用`pear install phpdocumentor/phpdocumentor`命令进行安装。如果选择手动...
1. **安装**:你可以通过 Composer,在项目中添加 PHPDocumentor 作为依赖。在命令行运行 `composer require phpdocumentor/phpdocumentor`。 2. **配置**:创建一个 `.phpdoc.dist.xml` 或 `.phpdoc.xml` 配置文件...
1. **安装**:可以通过Composer在全球范围内安装PHPDocumentor,只需在命令行中输入`composer require phpdocumentor/phpdocumentor`。 2. **配置**:创建一个配置文件(通常是`phpdoc.dist.xml`或`phpdoc.xml`),...
phpDocumentor v1.4.3 Web Interface 使用PhpDocument生成帮助文档说明 有利于项目维护 内有使用说明,采用word文档方式介绍如何使用phpDocumentor 还包含图片说明
在命令行方式下,可以在phpDocumentor的安装目录下输入命令,并附带参数来指定文件名、目录、存放路径和输出格式等。例如,使用“phpdoc-oHTML:frames:earthli-ftest.php-tdocs”参数就会生成一个HTML格式的API文档...
PHP Documentor 是PEAR (PHP Extension and Application Repository) 下的一个模块,它支持Linux、Windows等多种操作系统。 安装PHP Documentor之前,首先要确认系统中是否已经安装了PEAR库。若未安装,可以通过...
1. **安装**:可以使用Composer(PHP的依赖管理工具)在全球范围内安装`phpDocumentor`。 2. **配置**:根据项目需求,可以自定义`phpdoc.xml`或`phpdoc.dist.xml`配置文件。 3. **运行**:执行`phpdoc`命令,解析...
php-phpdocumentor-reflection-docblock5-5.1.0-1.el7.remi.noarch.rpm
- 使用 `-j` 或 `--javadocdesc` 命令行选项,phpDocumentor 可以支持 JavaDoc 风格的文档块,但推荐遵循 PHPDoc 标准。 **应用场景** PHPDoc 不仅用于生成 API 文档,还能帮助 IDEs 分析代码,提供类型提示和代码...
PEAR Installer是此软件,其中包含可执行文件和PHP代码,这些代码用于从pear.php.net下载和安装PEAR代码。 PEAR包含有用的软件库和应用程序,例如MDB2(数据库抽象),HTML_QuickForm(HTML表单管理),...
phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序。 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性。 phpDocumentor 2的特点: 兼容...
php-phpdocumentor-reflection-docblock5-5.2.0-1.el7.remi.noarch.rpm
3. 安装phpDocumentor:通过PEAR发现phpdoc频道并安装最新版本。 **使用方法:** 1. 在PHP根目录下,使用`phpdoc`命令指定源代码目录(`-d`)和目标文档生成目录(`-t`)。也可以使用`-f`指定单个文件。 2. 示例...
php-phpdocumentor-reflection-common2-2.2.0-1.el7.remi.noarch.rpm
安装 phpDocumentor 有两种方式:通过 PEAR 远程安装和手动下载安装。 1. **通过 PEAR 远程安装** 使用 PEAR 安装非常简便,只需要运行以下命令即可: ```shell pear install PhpDocumentor/PhpDocumentor ```...
php-phpdocumentor-type-resolver1-1.3.0-1.el7.remi.noarch.rpm
PEAR Installer是此软件,它包含可执行文件和PHP代码,这些代码用于从pear.php.net下载和安装PEAR代码。 PEAR包含有用的软件库和应用程序,例如MDB2(数据库抽象),HTML_QuickForm(HTML表单管理),PhpDocumentor...