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

基本语法

• 注释代码以/开始，以/结束
• 注释不能嵌套
• 示例
  /* 注释内容 */

团队约定

注释内容

*对于一般性注解，书写简单的短语；对于较长的注解，书写完整的句子。

• 推荐写法
  /* 用户头像 */
  .avatar {
  200rpx;
  height: 200rpx;
  }
• 不推荐写法
  /* 这是用户头像的样式 */
  .avatar {
  200rpx;
  height: 200rpx;
  }

注释位置

注释应该写在被注释代码块的上一行

• 推荐写法
  /* 用户昵称 */
  .name {
  color: #fff;
  }
• 不推荐写法
  .name {/* 用户昵称 */
  color: #fff;
  }

注释格式

注释内容的第一个字符和最后一个字符皆为一个空格字符

• 推荐写法
  /* 用户昵称 */
  .name {
  color: #fff;
  }
• 不推荐写法
  /用户昵称/
  .name {
  color: #fff;
  }

单行注释

单行注释单独占一行

• 推荐写法
  /* 用户昵称 */
  .name {
  color: #fff;
  }
• 不推荐写法
  .name {/* 用户昵称 */
  color: #fff;
  }

模块注释

注释开始字符/和注释内容在同一行，-组成的线和结束字符/另起一行

• 推荐写法
  /* 模块A
  -------------------------------------------------- */
  .modules_a {}

  /* 模块B
  -------------------------------------------------- */
  .modules_b {}
  

• 不推荐写法
  /* 模块A -------------------------------------------------- */
  .modules_a {}

  /* 模块B -------------------------------------------------- */
  .modules_b {}