文件头部注释代码块插件
koroFileHeader
/** * @description: 获取数据函数 * @param {obj} v 对象 * @param {array} Tdata 为true的数据 * @param {array} FData 为false的数据 * @return {*} return出去的是执行数据 */ //上面的都可以写 // 触发方法 1. 放在函数头部上必须为空白的一行 2. window按下 ctrl+alt+t 3.mac:ctrl+cmd+t
/* * @Author: 作者名字 * @Date: 开始书写时间 * @LastEditTime: 最后书写时间(注释创建时间) * @LastEditors:最后编写人 * @Description: 文件描述 * @FilePath: 文件路径 */ // 触发方法 1. 放在函数头部上必须为空白的一行 2. window按下 ctrl+alt+i 3.mac:ctrl+cmd+i
标识含义
@api: 提供给第三方使用的接口 @author: 标明作者 @param: 参数 @return: 返回值 @todo: 待办 @version: 版本号 @inheritdoc: 文档继承 @property: 类属性 @property-read: 只读属性 @property-write: 只写属性 @const: 常量 @deprecated: 过期方法 @example: 示例 @final: 标识类是终态, 禁止派生 @global: 指明引用的全局变量 @static: 标识类、方法、属性是静态的 @ignore: 忽略 @internal: 限内部使用 @license: 协议 @link: 链接,引用文档等 @see: 与 link 类似, 可以访问内部方法或类 @method: 方法 @package: 命名空间 @since: 从指定版本开始的变动 @throws: 抛出异常 @uses: 使用 @var: 变量 @copyright: 版权声明 @function:函数介绍