t;包-超类--基类--子类"的形式来体现你的框架结构要比使用"包-模块组-模块"的形式好的多。
@package label 使用范围:class, module
定义归属的包的信息,label 是这个包的名字。相同的包的名字的类在最终文档索引中将被分在一起。实际上,包还可以理解为不同的名字空间,虽然PHP没有名字空间的概念,但是你可以把相关的类、模块都归属于同一个包,这样,相当于组织了一个名字空间,当然,你的应用框架可能会有不同的包,可惜的是,这种情况下从语法上是得不到名字空间这种保证的,你只能通过人为地去避免不同的包的函数或者类重名。
@param[eter] (object objecttype|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|type) [$varname] 使用范围:function
定义函数或者方法的返回信息。
返回信息的类型同@param一样,$varname是返回变量的名称,可有可无。不同的是@return只有一个,不会出现多个@return
@see (function()|$varname|((module|class)::)(function()|$varname)) [, ...] 使用范围:class, function, var, module, define, use
定义需要参考的函数、变量,并加入相应的超级连接。这也是较常用的标记。对于相关的函数,变量,你可以使用@see来增加一个到相关函数和变量的链接。多个相关的函数、变量写在一行,中间用逗号来分隔。
参考的函数、变量如
@package label 使用范围:class, module
定义归属的包的信息,label 是这个包的名字。相同的包的名字的类在最终文档索引中将被分在一起。实际上,包还可以理解为不同的名字空间,虽然PHP没有名字空间的概念,但是你可以把相关的类、模块都归属于同一个包,这样,相当于组织了一个名字空间,当然,你的应用框架可能会有不同的包,可惜的是,这种情况下从语法上是得不到名字空间这种保证的,你只能通过人为地去避免不同的包的函数或者类重名。
@param[eter] (object objecttype|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|type) [$varname] 使用范围:function
定义函数或者方法的返回信息。
返回信息的类型同@param一样,$varname是返回变量的名称,可有可无。不同的是@return只有一个,不会出现多个@return
@see (function()|$varname|((module|class)::)(function()|$varname)) [, ...] 使用范围:class, function, var, module, define, use
定义需要参考的函数、变量,并加入相应的超级连接。这也是较常用的标记。对于相关的函数,变量,你可以使用@see来增加一个到相关函数和变量的链接。多个相关的函数、变量写在一行,中间用逗号来分隔。
参考的函数、变量如
| 对此文章发表了评论 |
