前端注释规范

黄毛火烧雪下2024-09-29 13:53

1、目的和原则

提高可读性和可维护性

如无必要，无增注释；如有必要，尽量详尽

2、语法

单行注释： //

多行注释： /**/

3、规范

1、注释符与注释内容之间加一个空格

2、注释行与上方代码间加一个空行

4、Javascript

为函数的入参与输出做详细注释，便于使用者一目了然功能与所需参数;

bash 复制代码

    /**
    * 函数描述
    * 与此函数相关联引入的其他函数，并说明该函数具体位置以及说明其功能
    * @param {string} p1 参数1的说明
    * @param {string} p2 参数2的说明，比较长
    *     那就换行了.
    * @param {number=} p3 参数3的说明（可选）
    * @return {Object} 返回值描述
    */

5、文件头部信息注释

vscode 插件 koroFileHeader 可配置自动生成头部信息

bash 复制代码

"fileheader.customMade": {
  "Author": "git config user.name", //作者
  "Email": "git config user.email", //邮箱
  "Description": "功能或页面描述",
  "Date": "Do not edit", //文件生成时间
  "LastEditors": "git config user.name", //最后更改人
  "LastEditTime": "Do not edit",
},