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 的批次档,我们就可以用这个批次档来产生我们的文件。

时间: 2024-10-13 12:41:12

PhpDocumentor的相关文章

PHPDocumentor代码注释规范说明

   PHPDocumentor是一个的用PHP写的道具,对于有规则注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档. 标记 用途 描述 @abstract   抽象类的变量和方法 @access public, private or protected 文档的访问.使用权限. @access private 表明这个文档是被保护的. @author 张三 <[email protected]> 文档作者 @copyright 名称 时间 文档版权信息 @deprecate

PHPDocumentor 注释规范整理

你会写注释么?从我写代码开始,这个问题就一直困扰着我,相信也同样困扰着其他同学.以前的写注释总是没有一套行之有效的标准,给维护和协同开发带了许多麻烦,直到最近读到了phpdocumentor的注释标准. 下面对phpdocumentor的注释标准进行总结: Type(数据类型): string 字符串类型 integer or int 整型 boolean or bool 布尔类型 true or false float or double 浮点类型 object 对象 mixed 混合类型 没

PhpDocumentor 生成文档

最近项目需要phpdoc生成文档,首先安装PhpDocumentor,利用pear安装: 切换用户: su root 安装PhpDocumentor: pear install PhpDocumentor 生成文档: Phpdoc –h 会得到一个phpDocumentor的详细参数列表.先看看最重要的几个吧. -d 这个目录代表着需要生成文档的原始php文件目录(注意是目录) -t 这个目录代表着生成的文档存放目录 -o 这个参数代表着生成的文档格式,例如html格式,参数就是 phpdoc

PHPDocumentor 整理目光规范

你会写凝视么?从我写代码開始.这个问题就一直困扰着我.相信也相同困扰着其它同学.曾经的写凝视总是没有一套行之有效的标准,给维护和协同开发带了很多麻烦,直到近期读到了phpdocumentor的凝视标准. 以下对phpdocumentor的凝视标准进行总结: Type(数据类型): string 字符串类型 integer or int 整型 boolean or bool 布尔类型 true or false float or double 浮点类型 object 对象 mixed 混合类型 没

PHP的学习--使用PhpDocumentor 2生成API文档

官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序. 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性. phpDocumentor 2的特点: 兼容php5.3,全面支持命名空间和闭包等. 识别支持任何tag,以及一些追加的 (比如 @link

php一键环境包xammp 安装 phpDocumentor

1.phpDocumentor简介. PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档.老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便. phpDocumentor是一个非常强大的文档自动生成工具,利用它可以帮助我们编写规范的注释,生成易于理解,结构清

windows下安装PhpDocumentor(phpdoc)笔记

PhpDocumentor简介 PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档.老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便. 参考介绍: 百度百科:http://baike.baidu.com/view/1269751.htm 维基百科:http

怎样安装phpDocumentor

尝试了win下用pear安装.不明原因,装不上.手动安装后,win下无法执行,linux下又可以执行. 直接访问:https://github.com/phpDocumentor/phpDocumentor2/releases 下载过后解压缩. 需要在linux下执行,目录是phpDocumentor-2.9.0/bin ./phpdoc -d /home/your/导出注释的文件夹 -t /home/your/docs

给php代码添加规范的注释phpDocumentor

给php代码添加规范的注释更多参考 http://phpdoc.org/docs/latest/index.html在phpdocumentor中,注释分为文档性注释和非文档性注释.所谓文档性注释,是那些放在特定关键字前面的多行注释,特定关键字是指能够被phpdoc分析的关键字,例如class,var等,具体的可参加附录1.那些没有在关键字前面或者不规范的注释就称作非文档性注释,这些注释将不会被phpdoc所分析,也不会出现在你产生的api文当中.3.2如何书写文档性注释:所 有的文档性注释都是

phpDocumentor学习使用记录

一.phpDocumentor简介 PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档.老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便. phpDocumentor是一个非常强大的文档自动生成工具,利用它可以帮助我们编写规范的注释,生成易于理解,结构清晰