[摘要]type) [varname] [description] 使用范围:function 定义函数或者方法的参数信息。这是最常使用的文档标记了。ojecttype 是对象的类名,type 指出这个参数...
type) [$varname] [description] 使用范围:function
定义函数或者方法的参数信息。这是最常使用的文档标记了。
ojecttype 是对象的类名,type 指出这个参数的类型,它可以是下列类型:
string 该参数是一个字符型变量。
array 该参数是一个数组。
integer 该参数是一个数值型。
integer (octal) 该参数是一个数值型,并且是按照八进制方式存放。
integer (hexadecimal) 该参数是一个数值型,并且是按照十六进制方式存放。
boolean 该参数是一个布尔型。
mixed 该参数的类型是可变的,可以上面几种类型的组合。不过,在随后的说明中一般要说明可以接受的变量的类型。
$varname 是形参的名称
[description] 是对于参数的说明。
如果函数接受的是多个参数,那么要按照从左到右,依次用@param对齐列出,如下面所示:
*
* @param array $tags array of tags returned by getTags
* @param array $data array where the allowed tags and their values are copied to
* @param array $allowed array of allowed (recognized) tags
@return (object objecttype
关键词:PEAR:运用PHPDoc简单创建你的PEAR文档