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

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

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

  */
class paint_start {
/**
* 绘制数量
* @abstract
*/
var $number;
/**
* 绘制五星图案
* @abstract
*/
function paint() {
;
}
}


@access (public|private) 使用范围:class, function, var, define, module

指明这个变量、类、函数/方法的存取权限。如果你的函数是内部使用,你应该指明它为private,这样的好处是,即使php不能阻止其他的人使用你的私有数据,但是至少你向你的用户传达这样的信息,这是一个私有的函数,因此不保证在将来的版本中仍存在;对于使用者而言,表示为@private的数据和方法,你不应该直接使用,即使你可以这样做。

举例:
/**
* 这是一个绘五星图案的抽象类.
* @abstract
* @access public
*/
class paint_start {

/**
* 绘制数量
* @abstract
* @access private
*/
var $number;

/**
* 绘制五星图案
* @abstract
* @access public
*/
function paint() {
;
}

}


@author name [<email>] [, ...] 使用范围:class, function, var, define, module, use

指明作者信息,依次是作者姓名,email地址,其他的通讯信息。如果有多个作者,按照其先后次序,使用多个@author依次列出:

* @author night sailer <night@hotmail.com>
* @author lee tester <tester@gnome.org>
@brother (function()|$variable) 使用范围:class, function, var, define, module, use
@sister (function()|$variable) 使用范围:class, function, var, define, module, use

指出兄弟类、函数或者是变量.这些函数、类、变量等有相似的信息和并实现相同的功能。比如,调用和返回的参数的个数和类型相同,实现的功能也一样。这种情况,你可以使用@brother 或者 @sister指明它的兄弟函数,无须在重复书写函数的功能等信息了。

举例:
/**
* 这是一个绘五星图案的抽象类.
* @abstract
* @access public
*/
class paint_start {

/**
* 绘制数量
* @abstract

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

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

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

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

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

    供求信息




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