[摘要]variable) 使用范围:class, function, var, define, module, use 指出兄弟类、函数或者是变量.这些函数、类、变量等有相似的信息和并实现相同的功能。比如...
$variable) 使用范围:class, function, var, define, module, use
指出兄弟类、函数或者是变量.这些函数、类、变量等有相似的信息和并实现相同的功能。比如,调用和返回的参数的个数和类型相同,实现的功能也一样。这种情况,你可以使用@brother 或者 @sister指明它的兄弟函数,无须在重复书写函数的功能等信息了。
举例:
/**
* 这是一个绘五星图案的抽象类.
* @abstract
* @access public
*/
class paint_start {
/**
* 绘制数量
* @abstract
* @access private
*/
var $number;
/**
* 绘制五星图案
* @abstract
* @access public
*/
function paint() {
;
}
/**
* @brother paint()
*/
function draw() {
;
}
}
@const[ant] label [description] 使用范围:define
指明常量
这个标记实际上是用来说明php的define关键字定义的常量。
@copyright description 使用范围:class, function, var, module, define, use
指明版权信息。
@deprec[ated] label 使用范围:class, function, var, module, define, use
指明不推荐或者是废弃的信息.
如果你的某个函数或者方法,已经被新的函数方法替代,或者是已经废弃,不希望读者继续使用。那么你可以使用这个标志告诉读者,这个函数只是为了保持兼容性而保留的,它不被推荐使用,如果它已经被其他函数替代,也要指出这个替代者。
例子:
/**
* 过时的类
*
* @deprec 1.5-2000/12/06
* @access public
*/
function dontUseMeAnyMore() {
print "Don't use me any more. I have been deprecated.";
}
@exclude label 使用范围:class, function, var, module, define, use
指明当前的注释将不进行分析,不出现在文挡中
@final 使用范围:class, function, var
指明这是一个最终的类、方法、属性,禁止派生、修改。
举例:
/**
* 圆周率
* @final
*/
var $PI = 3.1415926;
@global (object objecttype
关键词:PEAR:运用PHPDoc简单创建你的PEAR文档