前端代码注释规范
目的和原则
提高可读性和可维护性
如无必要,勿增注释;如有必要,尽量详尽
语法和快捷键
单行注释://
快捷键: ctrl+/
多行注释:/**/
快捷键: ctrl+shift+/
规范
1、注释符与注释内容之间加一个空格
2、注释行与上方代码间加一个空行
HTML
顶部文档注释
/** * @description: 中文说明 * @author: name * @update: name(xxxx-xx-xx) */
CSS
/* content */ 内容 /* end content */
JS
函数
/** * @func * @todo 这个函数需要优化 * @desc 一个带参数的函数 * @param {string} a - 参数a * @param {number} b=1 - 参数b默认值为1 * @param {string} c=1 - 参数c有两种支持的取值</br>1—表示x</br>2—表示xx * @param {object} d - 参数d为一个对象 * @param {string} d.e - 参数d的e属性 * @param {string} d.f - 参数d的f属性 * @param {object[]} g - 参数g为一个对象数组 * @param {string} g.h - 参数g数组中一项的h属性 * @param {string} g.i - 参数g数组中一项的i属性 * @param {string} [j] - 参数j是一个可选参数 * @returns {boolean} 返回值为true */