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

注释

代码是由人编写并维护的，我们要尽可能保证写的代码能够自描述、注释良好并且易于他人理解。好的注释能够传达上下文关系和代码目的。

注释代码以结尾。

• 标准写法
  
• 错误写法
  <!--> 动态列表 -->
  <!---> 动态列表 <-->

团队约定

单行注释

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

• 注释内容前后各一个空格字符
• 注释位于注释代码上面
• 单独占一行

示例

• 推荐写法：
  
  ...

• 不推荐写法：
  
  ...

  <!--积--分--信息-->
  <view> ... </view>
  
  <!-- 积分信息 --->
  <view> ... </view>
  
  <view> ... </view> <!-- 积分信息 -->
  
  <view>  <!-- 积分信息 -->
      ... 
  </view>
  

代码块注释

一般用于描述某一块代码的名称或开始，结束位置。书写时应该遵循以下规范

• 注释内容前后各一个空格字符
• 表示代码块开始， 表示代码块结束
• 代码块与代码块之间相隔一行

示例

• 推荐写法：
  
  
  ...
  
  

  <!-- 评论列表 开始 -->
  <view class="comment_list"> 
      ...
  </view>
  <!-- 评论列表 结束 -->
  

• 不推荐写法：
  
  
  ...
  
  
  
  
  ...
  
  

嵌套代码块注释

用于代码块内嵌套的代码块的注释，注释格式由

<!-- 注释内容 开始 -->
<!-- 注释内容 结束 -->

改为

<!-- /注释内容 -->

示例：

• 推荐写法：
  
  

      <view class="personal_info">
          ...
      </view>
      <!-- /个人信息 -->
      
      <view class="personal_event_list">
          ...
      </view>
      <!-- /动态列表 -->
      
  </view>
  <!-- 个人主页 结束 -->
  

• 不推荐写法：
  
  

      <!-- 个人信息 开始 -->
      <view class="personal_info">
          ...
      </view>
      <!-- 个人信息 结束 -->
      
      <!-- 动态列表 开始 -->
      <view class="personal_event_list">
          ...
      </view>
      <!-- 动态列表 结束 -->
      
  </view>
  <!-- 个人主页 结束 -->