微信小程序开发规范文档-JavaScript注释规范

时间:2024-03-10 19:58:07

注释

注释分为单行注释和多行注释。

单行注释以//开头。

// 单行注释示例

多行注释以/开始,以/结束。

/*
 * 多行注释
 * 示例
 */

团队约定

单行注释

一般用于简单的描述,如状态描述,属性描述等。书写时应遵循以下规范:

  • 注释符号//与注释内容之间一个空格字符
  • 注释位于注释代码上面
  • 单独占一行

示例

  • 推荐写法:
    // 初始化
    let statusCode = -1;
  • 不推荐写法:
    //初始化
    let statusCode = -1;
    let statusCode = -1; // 初始化

多行注释

一般用于描述某一块代码的功能,逻辑思路,或参数说明等。书写时应该遵循以下规范

  • 注释开始符号/和结束符号/各占一行
  • 结束符号*/前面加一个空格字符
  • 代码块与代码块之间相隔一行

示例

  • 推荐写法:
    /*
    * 多行注释
    * 多行注释
    * 多行注释
    */

  • 不推荐写法:
    /* 多行注释
    * 多行注释
    * 多行注释
    * 多行注释
    */

     /* 多行注释多行注释 */
    

文件注释

文件注释位于文件的最前面,主要是对当前这个文件的代码做个整体说明或注意的事项

示例