javascript注释规范

js的组织是模块化，一个模块对应一个js文件。

模块功能描述说明：

/**
 * ------------------------------------------------------------------
 * 模块描述说明
 * ------------------------------------------------------------------
 */

模块内的小函数方法归类：

/**
 * 小函数方法归类说明，这些零散的小函数方法放在一起 对应 一个业务方法逻辑
 * ------------------------------------------------------------------
 */

把一个业务方法中抽取出来的小函数放在一起，便于查找。

单个函数方法：

/**
 * 函数功能简述
 *
 * 具体描述一些细节
 *
 * @param    {string}  address     地址
 * @param    {array}   com         商品数组
 * @param    {string}  pay_status  支付方式
 * @returns  void
 *
 * @date     2014-04-12
 * @author   QETHAN
 */

单行注释：

//这是一条单行注释

有些人喜欢这样 // 这是一条单行注释 双斜杠后边会加一个空格。我不认同。喜欢干练清晰简洁，在适合的时候，就一定会这样做。

单个函数方法中变量注释：

//商品属性变量(一组变量描述)
    //商品名字(单个变量注释)
var name = $(item).find('.js-name').val(),
    //商品数量
    count = $(item).find('.js-count').text(),
    //商品单价
    price = $(item).find('.js-price').val();

有些喜欢注释放在单个变量后边。如果变量注释有点长，就不太好了。放在上边，比较省心，清晰。

单个函数方法中代码片段注释：

/*
 | 代码片段的描述说明
 */