代码注释格式

发表于

@module声明模块

1
2
3
4
/**
* 模块说明
* @module 模块名
*/


@class声明类

1
2
3
4
5
/**
* 类说明
* @class 类名
* @constructor
*/


@method声明函数或类方法

1
2
3
4
5
6
7
/**
* 方法说明
* @method 方法名
* @for 所属类名
* @param {参数类型} 参数名 参数说明
* @return {返回值类型} 返回值说明
*/


@property声明类属性

1
2
3
4
/**
* 属性说明
* @property {属性类型} 属性名
*/


注：

  • ​ 需要花费几分钟来理解的代码块，都应该有注释

  • 处理特殊情况的语句，应该有注释

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    /**
     * 推荐
     * 用来说明代码块
     */
    function initSku(params) {
        params = params || {}; //用来说明单语句，并且放在语句后面
    }

    // 还行
    // 用来说明代码块，并且放在代码块上面
    function initSku(params) {
        params = params || {}; //用来说明单语句，并且放在语句后面
    }