您现在的位置: 无忧电子商务网 >> 信息学院 >> 程序开发 >> php >> 正文

使用PHPDoc轻松建立你的PEAR文档

作者:佚名    信息学院来源:整理    点击数:    更新时间:2008-2-2 我要参与讨论

  * @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|type) [$varname] [description] 使用范围:function
指明在此函数中引用的全局变量
举例:
/**
* simuliert include_once in php 3.
*
* @global array $__used_files 已经include的文件列表
* @access public
*/
function include_once($filename) {
global $__used_files;

if (!isset($__used

上一页  [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]  ... 下一页  >> 

在google里搜索更多使用PHPDoc轻松建立你的PEAR文档

Google
Web www.51ec.org
  • 上一篇信息学院:

  • 下一篇信息学院:
  • 【字体: 】【发表评论】【加入收藏】【告诉好友】【打印此文】【关闭窗口
    我来说两句 对此文章发表了评论
      昵 称: *必填    ·注册用户·
      评 分: 1分 2分 3分 4分 5分     严禁发表危害国家安全、政治、黄色淫秽等内容的评论,用户需对自己在使用本网站服务过程中的行为承担法律责任。本站管理员有权保留或删除评论内容,评论内容只代表机友个人观点,与本网站立场无关。  
    评 论
    内 容

     
    评论列表 (最新 评论仅限网友观点!)

    供求信息




    | 设为首页 | 加入收藏 | 关于我们 | 广告服务 | 联系方式 | 友情链接 | 版权申明