docblock的描述标记
<b> -- 强调/黑体
<code> -- 用于围绕php代码,可以显示语法高亮
<br> -- 换行标识,但有可能被一些文档转换器忽略
<i> -- 斜体,用于表示重要的内容
<kbd> -- 代表键盘输入/屏幕显示
<li> -- 列表元素
<ol> -- 顺序列表
<p> -- 段落标记
<pre> -- 换行和空格保留标记(把所有标记认为是纯文本)
<samp> -- 代表例子(非php)
<ul> -- 无序列表
<var> -- 代表变量名
特殊用法:
a) 在极少的情况下,<b>用<<b>>来表示
b) 如果需要在docblock中使用’@’符号,需要加上转义符,即用’\@’表示
c) 如果需要在docblock中使用’*/’符号,需要使用’{@*}’
标签
标签就是以’@’开头的一个标记,用于告诉phpDocumentor如何表示信息以及修改文档的展示方式。
* @abstract
* @access 共有或者私有
* @author 作者姓名 <作者email>
* @copyright 名称 日期
* @deprecated 描述
* @deprec 描述的别名
* @example /path/to/example
* @exception 与Javadoc兼容
* @global 类型 $globalvarname
or
* @global 函数中使用的全局变量描述
* @ignore
* @internal 内部信息或者高级程序员使用
* @param 类型 [$varname] 描述
* @return 类型 描述
* @link URL
* @name 页面别名
or
* @name 全局别名
* @magic 兼容phpdoc.de
* @package 包名称
* @see 名称或其他能记录在文档中的内容,
* 在文档中生成一个指向内容的链接
* @since 版本或者日期
* @static
* @staticvar 函数中使用的静态变量的描述
* @subpackage 项目中分组后的子包
* @throws 兼容Javadoc
* @todo 兼容phpdoc.de
* @var 类型,类成员的数据类型
* @version 版本