前端程式碼註釋規範

目的和原則

提高可讀性和可維護性
如無必要，勿增註釋；如有必要，儘量詳盡

語法和快捷鍵

單行註釋：//　快捷鍵： ctrl+/
多行註釋：/**/ 快捷鍵： ctrl+shift+/

規範

1、註釋符與註釋內容之間加一個空格
2、註釋行與上方程式碼間加一個空行

HTML

頂部文件註釋

 /**
  * @description: 中文說明
  * @author: name
  * @update: name(xxxx-xx-xx)
  */

CSS

/* content */
內容
/* end content */

JS

函式

/**
 * @func
 * @todo 這個函式需要優化
 * @desc 一個帶引數的函式
 * @param {string} a - 引數a
 * @param {number} b=1 - 引數b預設值為1
 * @param {string} c=1 - 引數c有兩種支援的取值</br>1—表示x</br>2—表示xx
 * @param {object} d - 引數d為一個物件
 * @param {string} d.e - 引數d的e屬性
 * @param {string} d.f - 引數d的f屬性
 * @param {object[]} g - 引數g為一個物件陣列
 * @param {string} g.h - 引數g陣列中一項的h屬性
 * @param {string} g.i - 引數g陣列中一項的i屬性
 * @param {string} [j] - 引數j是一個可選引數 
 * @returns {boolean} 返回值為true
 
 
*/