Skip to content

注释规范

单行注释

  • 单行注释独占一行。 // 后预留一个空格
js
// Content Text

多行注释

函数/方法注释

js
/**
 * @description: 描述信息
 * @param {*} a 参数说明
 * @param {*} b 参数说明
 * @return {*}  返回值描述
 */

文件注释:

  • 文件注释,可以通过配置编辑器的插件,来实现自动添加
js
/*
 *@Author: author
 *@Date: 2021-06-05 11:20:43
 *@LastEditors: author
 *@LastEditTime: 2021-06-05 13:24:01
 *@FilePath: /**/*.js
 */