注释规范

模块功能

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

模块内的小函数方法归类

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

单个函数方法

/*-
 - 函数功能简述
 -
 - 具体描述一些细节
 -
 - @param    {string}  address     地址
 - @param    {array}   com         商品数组
 - @param    {string}  pay_status  支付方式
 - @returns  void
 -
 - @date     2017-12-12
 - @author   PANGRUI<jobrzy@163.com>
 */

单行

//这是一条单行注释

单个函数方法中变量注释

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