式存放。
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来增加一个到相关函数和变量的链接。多个相关的函数、变量写在一行,中间用逗号来分隔。
参考的函数、变量如果是当前类或模块的,那么你可以直接写函数、或者变量的名,如果是函数那么要在函数名后面加上括号(),变量名要加上$。需要注意的,这里所谓的变量名也应该是你用@var来说明过的,否则,phpdoc将无法找到相关的参照而报错。
如果你想引用其他类或者其他模块的函数或者是变量,那么,你可以在函数名、变量名前面加上类或模块的名字作为范围指示,中间用::来分隔。
下面是一些例子:
@see $run_time,$idle_time,$begin_time,$end_time
@see getruntime(), getidletime(),getbegintime(),getendtime()
@see time::$run_time, time::getbegintime()
@since label 使用范围: class, function, var, module, define, use
指明该api函数或者方法是从哪个版本开始引入的。
@static 使用范围:class, function, var
指明变量、类、函数是静态的。
@throws exception [, exception] 使用范围: function
指明此函数可能抛出的错误异常,极其发生的情况
如果你预料到在这个函数中有产生异常的条件,那么你可以使用@throws标记来说明这些异常是什么,什么情况下产生异常。比如,读取磁盘文件
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来增加一个到相关函数和变量的链接。多个相关的函数、变量写在一行,中间用逗号来分隔。
参考的函数、变量如果是当前类或模块的,那么你可以直接写函数、或者变量的名,如果是函数那么要在函数名后面加上括号(),变量名要加上$。需要注意的,这里所谓的变量名也应该是你用@var来说明过的,否则,phpdoc将无法找到相关的参照而报错。
如果你想引用其他类或者其他模块的函数或者是变量,那么,你可以在函数名、变量名前面加上类或模块的名字作为范围指示,中间用::来分隔。
下面是一些例子:
@see $run_time,$idle_time,$begin_time,$end_time
@see getruntime(), getidletime(),getbegintime(),getendtime()
@see time::$run_time, time::getbegintime()
@since label 使用范围: class, function, var, module, define, use
指明该api函数或者方法是从哪个版本开始引入的。
@static 使用范围:class, function, var
指明变量、类、函数是静态的。
@throws exception [, exception] 使用范围: function
指明此函数可能抛出的错误异常,极其发生的情况
如果你预料到在这个函数中有产生异常的条件,那么你可以使用@throws标记来说明这些异常是什么,什么情况下产生异常。比如,读取磁盘文件
| 对此文章发表了评论 |
