前端代码注释模板前端代码注释模板,请根据⾃⼰的使⽤情况⾃⾏筛选使⽤。
/**
* @name 名字
* @abstract 申明变量/类/⽅法
* @access 指明这个变量、类、函数/⽅法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example ⽰例
* @exclude 指明当前的注释将不进⾏分析,不出现在⽂挡中
* @final 指明这是⼀个最终的类、⽅法、属性,禁⽌派⽣、修改。
* @global 指明在此函数中引⽤的全局变量
* @include 指明包含的⽂件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者⽅法的参数信息
* @params 定义函数或者⽅法的参数集合信息
* @return 定义函数或者⽅法的返回信息
* @see 定义需要参考的函数、变量,并加⼊相应的超级连接。
* @since 指明该api函数或者⽅法是从哪个版本开始引⼊的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发⽣的情况
* @todo 指明应该改进或没有实现的地⽅
* @var 定义说明变量/属性。
* @version 定义版本信息
* @createdTime 创建时间
* @lastModifiedTime 最后更改时间
*/
论坛前端模板欢迎朋友们评论区留⾔拓展~