微信小程序開發規范文檔-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>
  <!-- 個人主頁 結束 -->