微信小程序開發規范文檔-WXSS注釋規范

基本語法

• 注釋代碼以/開始，以/結束
• 注釋不能嵌套
• 示例
  /* 注釋內容 */

團隊約定

注釋內容

*對於一般性注解，書寫簡單的短語；對於較長的注解，書寫完整的句子。

• 推薦寫法
  /* 用戶頭像 */
  .avatar {
  width: 200rpx;
  height: 200rpx;
  }
• 不推薦寫法
  /* 這是用戶頭像的樣式 */
  .avatar {
  width: 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 {}