js中我的注釋規范

模塊功能描述說明：

/**
 * ------------------------------------------------------------------
 * 模塊描述說明
 * ------------------------------------------------------------------
 */

模塊內的小函數方法歸類：

/** * 小函數方法歸類說明，這些零散的小函數方法放在一起 對應 一個業務方法邏輯 * ------------------------------------------------------------------ */

單個函數方法：

/** * 函數功能簡述 * * 具體描述一些細節 * * @param {string} address 地址 * @param {array} com 商品數組 * @param {string} pay_status 支付方式 * @returns void * * @date 2014-04-12 * @author QETHAN<[e-mail]> */

單行注釋：

//這是一條單行注釋

單個函數方法中變量注釋：

//商品屬性變量(一組變量描述) //商品名字(單個變量注釋) var name = $(item).find('.js-name').val(), //商品數量 count = $(item).find('.js-count').text(), //商品單價 price = $(item).find('.js-price').val();

單個函數方法中代碼片段注釋：

/* | 代碼片段的描述說明 */

if, foreach, addEventListener ... 這些代碼片段的注釋中縮進 必須使用空格。保證各種環境下排版的一致性。