盾怪网教程:是一个免费提供流行杀毒软件教程、在线学习分享的学习平台!

PEAR:使用PHPDoc简单创建你的PEAR文档

时间:2025/1/15作者:未知来源:盾怪网教程人气:

[摘要]varname)) [, ...] 使用范围:class, function, var, module, define, use 定义需要参考的函数、变量,并加入相应的超级连接。这也是较常用的标记。...
$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标记来说明这些异常是什么,什么情况下产生异常。比如,读取磁盘文件出错,无法连接数据库,网络连接超时或者是在一些情况下,你"故意"抛出的异常等等。

@todo 使用范围:class, function, module, use
指明应该改进或没有实现的地方

@var[iable] (object objecttype

关键词:PEAR:运用PHPDoc简单创建你的PEAR文档




Copyright © 2012-2018 盾怪网教程(http://www.dunguai.com) .All Rights Reserved 网站地图 友情链接

免责声明:本站资源均来自互联网收集 如有侵犯到您利益的地方请及时联系管理删除,敬请见谅!

QQ:1006262270   邮箱:kfyvi376850063@126.com   手机版