前端注释规范

@file 对文件的描述，用于文件的头部
@author yussicahe <yussicahe@gmail.com>  代码的作者，在姓名后面用尖括号加上邮箱会被自动转成 mailto: 的链接
@copyright 2015 Tencent AlloyTeam 与@file结合使用，说明版权相关的信息
@license 说明许可证相关的信息
@type { 类型 } 标识一个类型，常和@enum搭配
@var { 类型 } 名字 描述 标识一个变量
@property { 类型 } 名字 描述 对象属性描述
@function 名字 描述 标识一个函数
@param { 类型 } 名字 描述  参数描述
@returns { 类型 }  描述 返回结果描述
@namespace { 类型 } 描述 标识一个命名空间
@desc 描述 对某个部分的详细描述
@summary 描述 对某个部分的简短描述
@constant { 类型 } 名字 描述 标识一个常量
@default 值 默认值
@enum 名字 枚举
@example 使用示例，通常或另起一行
@throws { 类型 } 描述 标识会抛出异常
@todo 描述  标识后续要做的事
@deprecated 废弃标识
@borrows foo as bar 复制注释，bar复制foo
@callback 名字 回调函数定义
@typedef 名字 自定义类型
@this 说明this所指的内容
@global 全局标识
@inner 内部属性或者方法标识
@ignore 忽略代码
@version 版本号
@since 版本号 表明该内容出现在一个特定的版本之后

来源：https://blog.csdn.net/randy521520/article/details/116536475