Javascript 注釋規(guī)范

ChanceWong 發(fā)布于2019-08-26 12:00 / 3076人閱讀

摘要：代碼注釋規(guī)范一語法注釋的說明語法寫在注釋塊第一行這是注釋的說明切換音頻播放狀態(tài)播放停止省略其它代碼標(biāo)簽語法標(biāo)簽的說明語法說明文字學(xué)生學(xué)生的名字類型語法可與標(biāo)簽結(jié)合使用，如必傳參數(shù)可選參數(shù)語法可與標(biāo)簽結(jié)合使用，如必傳參數(shù)可選參數(shù)參數(shù)有

Javascript 代碼注釋規(guī)范 一、語法 1. 注釋的說明

語法：寫在注釋塊第一行

/**
 * events-function(這是注釋的說明)
 * @description 切換音頻播放狀態(tài)（播放/停止）
 */
togglePlay: function() {
    // 省略其它代碼...
}

2. 標(biāo)簽

語法：@tagName

/** @function */
function fn() {

}

3. 標(biāo)簽的說明

語法：- 說明文字

/**
 * @constructor Student - 學(xué)生
 * @param {string} name - 學(xué)生的名字
 */
 function Student(name) {
     
 }

4. 類型

語法：{typeName} (可與標(biāo)簽結(jié)合使用，如@param)

/**
 * @param {string} a 必傳參數(shù)
 */
function fn(a, b, c) {

}

5. 可選參數(shù)

語法：[paramName] (可與標(biāo)簽結(jié)合使用，如@param)

/**
 *  @param {string} a 必傳參數(shù)
 *  @param {number} [b] 可選參數(shù)
 */
function fn(a, b) {

}

6. 參數(shù)有默認(rèn)值

語法：[paramName=value] (可與標(biāo)簽結(jié)合使用，如@param)

/**
 *  @param {string} a 必傳參數(shù)
 *  @param {number} [c=666] 參數(shù)有默認(rèn)值
 */
function fn(a, c) {

}

7. 鏈接

語法：[link text]{@link namepathOrURL}

/**
 * See {@link MyClass} and [MyClass"s foo property]{@link MyClass#foo}.
 * Also, check out {@link http://www.google.com|Google} and
 * {@link https://github.com GitHub}.
 */

二、示例 1. 函數(shù)

/**
 * 轉(zhuǎn)換時間字符串為時間對象
 * @function _str2time
 * @param strTime {String} - e.g "2017-02-13 10:02:58" or "2017-02-13" or "9:10"
 * @param type {String} - e.g date, dateTime, time
 */
function _str2time(strTime, type) {
    // 省略其它代碼
}

2. 類/構(gòu)造函數(shù)

/**
 * 定時器
 * @class Timer
 */

function Timer() {
    this._timeId = 0;
    this._eventId = -1;

    this.eventHandler = {
        "stop": {}
    };

    /**
     * 定時器是否處于停止?fàn)顟B(tài)
     * @memberof Timer
     * @member stopped
     * @instance
     */
    this.stopped = true;

    /**
     * 啟動定時器
     * @memberof Timer
     * @instance
     * @method start
     * @param {function} handler - 定時器每次執(zhí)行時調(diào)用的函數(shù)
     * @param {number} interval - 定時器執(zhí)行的時間間隔
     */
    this.start = function (handler, interval) {
        this.stopped = false;
        let _recursion = function() {
            this._timeId = setTimeout(() => {
                handler()
                    .then(() => {
                        if (this.stopped) {
                            clearTimeout(this._timeId);
                            this._trigger("stop");
                            return;
                        }
                        _recursion();
                    })
                    .catch(err => {
                        clearTimeout(this._timeId);
                        this.stopped = true;
                        this._trigger("stop");
                        if (err) throw new Error(err);
                    });
            }, interval)
        }.bind(this);
        _recursion();
    }

    /**
     * 停止定時器
     * @memberof Timer
     * @instance
     * @method stop
     */
    this.stop = function () {
        this.stopped = true;
    }
}

/**
 * 監(jiān)聽事件
 * @memberof Timer
 * @instance
 * @method on
 * @param {string} type - 事件類型  e.g "stop"
 * @param {function} fn - 事件處理函數(shù)
 * @return {number} eventId - 事件處理函數(shù)Id，用于取消監(jiān)聽
 */
Timer.prototype.on = function (type, fn) {
    let _eventId = fn.name || ++this._eventId;
    this.eventHandler[type][_eventId] = fn;
    return _eventId;
}

/**
 * 觸發(fā)事件
 * @private
 */
Timer.prototype._trigger = function (type) {
    let handlerMap = this.eventHandler[type];
    for (let key in handlerMap) {
        handlerMap[key]();
    }
}

/**
 * 取消監(jiān)聽事件
 * @memberof Timer
 * @instance
 * @method off
 * @param {string} type - 事件類型  e.g "stop"
 * @param {function} target - 事件處理函數(shù)Id或者函數(shù)名字
 */
Timer.prototype.off = function (type, target) {
    let _target = (typeof target === "function") ? target.name : target;
    delete this.eventHandler[type][_target];
}