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

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

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

  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_files["include_once"][$filename])) {
$__used_files["include_once"][$filename] = true;
include($filename);
}
}




@include description 使用范围:use
指明包含的文件的信息。
举例:
/**
* 抽象绘图类的定义.
*
* @include Function: _require_
*/
require("abstract.php");




@link URL description 使用范围:class, function, var, module, define, use
定义在线连接,如上面3.4中讲到的,你可以使用@link添加适当的在线链接。
例如:@link http://www.phpdoc.de/ PHPDoc Home

@magic description
这个标记在phpdoc中没有说明,具体用法现在仍不清楚

@module label 使用范围:module
定义归属的模块信息,label是模块的名字,拥有相同的模块名字的函数在索引分类中将被组合在一起。如果你没有使用OOP的思想来编写PEAR代码,那么建议你使用这个标记把相关的函数归集到相应的模块下面,这样你的整体的框架不至于过于零散和混乱。

@modulegroup label 使用范围:module
定义归属的模块组 label是这个模块组的名字,如果你的应用程序的模块很多,你可以把不同的模块按照逻辑功能的不同,划分成相应的模块组,这样,你的应用框架可以有比较清晰的逻辑关系。这是对于没有使用OOP编程的来说的,如果使用OOP的思想,没有必要使用模块组的概念,因为直接使用&quo

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

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

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

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

供求信息




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