首页 > 后端开发 > php教程 > php函数注释

php函数注释

WBOY
发布: 2016-08-08 09:19:28
原创
1289 人浏览过

PHPDoc风格的注释

<code><?php <span>/**
*<span> @name</span> 名字
*<span> @abstract</span> 申明变量/类/方法
*<span> @access</span> 指明这个变量、类、函数/方法的存取权限
*<span> @author</span> 函数作者的名字和邮箱地址
*<span> @category</span>  组织packages
*<span> @copyright</span> 指明版权信息
*<span> @const</span> 指明常量
*<span> @deprecate</span> 指明不推荐或者是废弃的信息MyEclipse编码设置
*<span> @example</span> 示例
*<span> @exclude</span> 指明当前的注释将不进行分析,不出现在文挡中
*<span> @final</span> 指明这是一个最终的类、方法、属性,禁止派生、修改。
*<span> @global</span> 指明在此函数中引用的全局变量
*<span> @include</span> 指明包含的文件的信息
*<span> @link</span> 定义在线连接
*<span> @module</span> 定义归属的模块信息
*<span> @modulegroup</span> 定义归属的模块组
*<span> @package</span> 定义归属的包的信息
*<span> @param</span> 定义函数或者方法的参数信息
*<span> @return</span> 定义函数或者方法的返回信息
*<span> @see</span> 定义需要参考的函数、变量,并加入相应的超级连接。
*<span> @since</span> 指明该api函数或者方法是从哪个版本开始引入的
*<span> @static</span> 指明变量、类、函数是静态的。
*<span> @throws</span> 指明此函数可能抛出的错误异常,极其发生的情况
*<span> @todo</span> 指明应该改进或没有实现的地方
*<span> @var</span> 定义说明变量/属性。
*<span> @version</span> 定义版本信息
*/
function XXX($a){...}</code>
登录后复制

以上就介绍了php函数注释,包括了方面的内容,希望对PHP教程有兴趣的朋友有所帮助。

相关标签:
来源:php.cn
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板