强迫症->js注释规范

之前自己写代码，就像一盘散沙，完全没有一种规范。这种自由，会让自己写的东西时常变化。也很不利于团队协作开发。经过最近一段时间的开发，和对一些注释风格的参考，形成了自己想去使用的注释规范。

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

模块功能描述说明：

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

我喜欢开始和结束各空一行，中间是描述内容。

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

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

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

单个函数方法：

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

开发中使用的是PhpStorm IDE, 每次创建一个js新文件，文件内容头部会根据配置文件模板去自动加上一些注释信息。我配置的是 日期 和 作者。现在是一个人开发，所以上边注释中的日期和作者 我一般不会在函数中去加上。但是，如果其他人参与进来了，自己修改的是别人的代码，就要更新添加这些注释信息。

单行注释：

//这是一条单行注释

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

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

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

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

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

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

if, foreach, addEventListener ... 这些代码片段的时候

注释中缩进 必须使用空格。保证各种环境下排版的一致性。

@use JSDoc

<持续维护更新...>