注释规范

文件注释

@FileDescription: 文件描述
@Author: 创建者
@Date: 创建日期
@LastEditors: 最后修改人
@LastEditTime: 最后修改时间

示例

vue

<!--
 * @FileDescription: 设置初始密码
 * @Author: 许如峰
 * @Date: 2023-04-12
 * @LastEditors: 许如峰
 * @LastEditTime: 2023-04-13
 -->

函数注释

@method 函数名
@description 函数的描述
@param 指定参数名和说明来描述一个函数参数

示例

javascript

/**
 * @name getPaymentList
 * @description 获取付款单列表
 * @param {String} projectId 项目ID
 * @param {Number} current 当前页
 * @param {Number} size 每页的数量
 */
function getPaymentList(projectId, current, size) {
  return request({
    url: '/erp/invoice/payment/info/page',
    method: 'get',
    params: {
        projectId,
        current,
        size
    }
  });
}

更多注释命令参照前端编程规约——注释规范