命令行方式
在phpDocumentor所在目录下输入phpdoc –h会得到一个详细的参数表其中几个重要的参数如下
f 要进行分析的文件名多个文件用逗号隔开
d 要分析的目录多个目录用逗号分割
t 生成的文档的存放路径
o 输出的文档格式结构为输出格式转换器名模板目录
例如phpdoc o HTML:frames:earthli f testphp t docs
Web界面生成
在新的phpdoc中除了在命令行下生成文档外还可以在客户端浏览器上操作生成文档具体方法是先把PhpDocumentor的内容放在apache目录下使得通过浏览器可以访问到访问后显示如下的界面
点击files按钮选择要处理的php文件或文件夹还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理
然后点击output按钮来选择生成文档的存放路径和格式
最后点击createphpdocumentor就会自动开始生成文档了最下方会显示生成的进度及状态如果成功会显示
Total Documentation Time: seconds
done
Operation Completed!!
然后我们就可以通过查看生成的文档了如果是pdf格式的名字默认为documentationpdf
给php代码添加规范的注释
PHPDocument是从你的源代码的注释中生成文档因此在给你的程序做注释的过程也就是你编制文档的过程
从这一点上讲PHPdoc促使你要养成良好的编程习惯尽量使用规范清晰文字为你的程序做注释同时多多少少也避免了事后编制文档和文档的更新不同步的一些问题
在phpdocumentor中注释分为文档性注释和非文档性注释
所谓文档性注释是那些放在特定关键字前面的多行注释特定关键字是指能够被phpdoc分析的关键字例如classvar等具体的可参加附录
那些没有在关键字前面或者不规范的注释就称作非文档性注释这些注释将不会被phpdoc所分析也不会出现在你产生的api文当中
如何书写文档性注释:
所有的文档性注释都是由/**开始的一个多行注释在 phpDocumentor里称为DocBlock DocBlock是指软件开发人员编写的关于某个关键字的帮助信息使得其他人能够通过它知道这个关键字的具体用途如何使用 PhpDocumentor规定一个DocBlock包含如下信息
功能简述区
详细说明区
标记tag
文档性注释的第一行是功能描述区正文一般是简明扼要地说明这个类方法或者函数的功能功能简述的正文在生成的文档中将显示在索引区功能描述区的内容可以通过一个空行或者 来结束
在 功能描述区后是一个空行接着是详细说明区 这部分主要是详细说明你的API的功能用途如果可能也可以有用法举例等等在这部分你应该着重阐明你的API函数或者方法的通常的用途用法并 且指明是否是跨平台的（如果涉及到）对于和平台相关的信息你要和那些通用的信息区别对待通常的做法是另起一行然后写出在某个特定平台上的注意事项 或者是特别的信息这些信息应该足够以便你的读者能够编写相应的测试信息比如边界条件参数范围断点等等
之后同样是一个空白行然后是文档的标记tag指明一些技术上的信息主要是最主要的是调用参数类型返回值极其类型继承关系相关方法/函数等等
文档注释中还可以使用例如<b> <code>这样的标签详细介绍请参考附录二
一个文档注释的例子
/**
* 函数add实现两个数的加法
*
* 一个简单的加法计算函数接受两个数ab返回他们的和c
*
* @param int 加数
* @param int 被加数
* @return integer
*/
function Add($a $b)
{
return $a+$b;
}
生成文档如下
Add
integer Add( int $a int $b)
[line ]
函数add实现两个数的加法
Constants 一个简单的加法计算函数接受两个数ab返回他们的和c
Parameters
• int $a 加数
• int $b 被加数
文档标记
文档标记的使用范围是指该标记可以用来修饰的关键字或其他文档标记
所有的文档标记都是在每一行的 * 后面以@开头如果在一段话的中间出来@的标记这个标记将会被当做普通内容而被忽略掉
@access
使用范围classfunctionvardefinemodule
该标记用于指明关键字的存取权限privatepublic或proteced
@author
指明作者
@copyright
使用范围classfunctionvardefinemoduleuse
指明版权信息
@deprecated
使用范围classfunctionvardefinemoduleconstentglobalinclude
指明不用或者废弃的关键字
@example
该标记用于解析一段文件内容并将他们高亮显示Phpdoc会试图从该标记给的文件路径中读取文件内容
@const
使用范围define
用来指明php中define的常量
@final
使用范围classfunctionvar
指明关键字是一个最终的类方法属性禁止派生修改
@filesource
和example类似只不过该标记将直接读取当前解析的php文件的内容并显示
@global
指明在此函数中引用的全局变量
@ingore
用于在文档中忽略指定的关键字
@license
相当于html标签中的<a>首先是URL接着是要显示的内容
例如<a href=”百度</a>
可以写作 @license 百度
@link
类似于license
但还可以通过link指到文档中的任何一个关键字
@name
为关键字指定一个别名
@package
使用范围页面级别的> definefunctioninclude
类级别的>classvarmethods
用于逻辑上将一个或几个关键字分到一组
@abstrcut
说明当前类是一个抽象类
@param
指明一个函数的参数
@return
指明一个方法或函数的返回指
@static
指明关建字是静态的
@var
指明变量类型
@version
指明版本信息
@todo
指明应该改进或没有实现的地方
@throws
指明此函数可能抛出的错误异常极其发生的情况
上面提到过普通的文档标记标记必须在每行的开头以@标记除此之外还有一种标记叫做inline tag用{@}表示具体包括以下几种
{@link}
用法同@link
{@source}
显示一段函数或方法的内容
一些注释规范
a注释必须是
/**
* XXXXXXX
*/
的形式
b对于引用了全局变量的函数必须使用glboal标记
c对于变量必须用var标记其类型（intstringbool）
d函数必须通过param和return标记指明其参数和返回值
e对于出现两次或两次以上的关键字要通过ingore忽略掉多余的只保留一个即可
f调用了其他函数或类的地方要使用link或其他标记链接到相应的部分便于文档的阅读
g必要的地方使用非文档性注释提高代码易读性
h描述性内容尽量简明扼要尽可能使用短语而非句子
i全局变量静态变量和常量必须用相应标记说明
总结
phpDocumentor是一个非常强大的文档自动生成工具利用它可以帮助我们编写规范的注释生成易于理解结构清晰的文档对我们的代码升级维护移交等都有非常大的帮助
关于phpDocumentor更为详细的说明可以到它的官方网站
两个例子
实例一
实例二
