前端规范（2）——注释规范

HTML 模块注释:

<!-- 文章列表列表模块 -->
<div class="article-list">
...
</div>

HTML 区块注释:

<!--
    @name: Drop Down Menu
    @description: Style of top bar drop down menu.
    @author: zhangsan
-->

JS 单行注释:
在代码上面注释，必须独占一行。// 后跟一个空格，缩进与下一行被注释说明的代码一致。

JS 后缀注释:
在一段语句后面后缀进行注释， // 前后都跟一个空格，用于对某个语句的说明。

this.getBaseDataAfter() // 基础数据请求完成之后执行的方法

JS 多行注释

    /**
    * 函数描述
    * 与此函数相关联引入的其他函数，并说明该函数具体位置以及说明其功能
    * @param {string} p1 参数1的说明
    * @param {string} p2 参数2的说明，比较长
    *     那就换行了.
    * @param {number=} p3 参数3的说明（可选）
    * @return {Object} 返回值描述
     */

JS 文件注释
文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西。 它的作者, 依赖关系和兼容性信息。如下:

/**
 * @fileoverview Description of file, its uses and information
 * about its dependencies.
 * @author [email protected] (Firstname Lastname)
 */

多进行注释，对于自行定义的一些对象参数必须进行注释说明如下：

{
    name: null, // 姓名
    mobile: null, // 手机号码
    id_card: null, // 身份证号
    monthly_income_money: '', // 月收入
}