前端代码注释规范
前端代码注释规范
目的和原则
提高可读性和可维护性。
如无必要，不要添加评论；必要时尽可能详细。
语法和快捷键
单行注释：//快捷键：ctrl/
多行注释：/* */快捷键：ctrl shift/
规范
1.在注释器和注释内容之间添加一个空格。
2.在注释行和上面的代码之间添加一个空行。
HTML
顶部文档注释
/**
* @description:中文描述
* @author:名称
* @update:名称(xxxx-xx-xx)
*/
CSS
/*内容*/
内容
/*结束内容*/
JS
函数
/**
* @func
* @todo此函数需要优化。
* @desc是一个带参数的函数
* @ param { string } a-参数a
* @ param { number } b=1-参数b的默认值为1。
* @ param { string } c=1-参数c有两个受支持的值/br1-用于x/br2-用于xx。
* @ param { object } d-参数d是一个对象。
* @param {string}参数d的d.e-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是可选参数。
* @返回{布尔值}返回值为真。
*/
内容来源网络，如有侵权，联系删除，本文地址：https://www.230890.com/zhan/116869.html