• 注册
热门标签
↑ 收起导航

PHP函数注释规范

码农一般都处于频繁Coding中,回过头再看自己2月前写的函数,估计也头大。。。因此,在此分享一些常用的函数注释标签及说明,建议大家尽量用吧!

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

发表评论 



我还是想用邮箱注册

登录

忘记密码 ?

用第三方帐号快捷登录

已有账户?前往登录吧~

注册