Javascript 注釋規範

2021-09-13 16:59:23 字數 2509 閱讀 9021

1. 注釋的說明

語法:寫在注釋塊第一行

/**

* events-function(這是注釋的說明)

*/toggleplay: function()

2. 標籤

語法:@tagname

/** @function */

function fn()

3. 標籤的說明

語法:- 說明文字

/**

* @constructor student - 學生

* @param name - 學生的名字

*/ function student(name)

4. 型別

語法: (可與標籤結合使用,如@param)

/**

* @param a 必傳引數

*/function fn(a, b, c)

5. 可選引數

語法:[paramname] (可與標籤結合使用,如@param)

/**

* @param a 必傳引數

* @param [b] 可選引數

*/function fn(a, b)

6. 引數有預設值

語法:[paramname=value] (可與標籤結合使用,如@param)

/**

* @param a 必傳引數

* @param [c=666] 引數有預設值

*/function fn(a, c)

7. 鏈結

語法:[link text]

/**

* see and [myclass's foo property].

* also, check out and

* .*/

1. 函式
/**

* 轉換時間字串為時間物件

* @function _str2time

* @param strtime - e.g "2017-02-13 10:02:58" or "2017-02-13" or "9:10"

* @param type - e.g date, datetime, time

*/function _str2time(strtime, type)

2. 類/建構函式
/**

* 定時器

* @class timer

*/function timer()

};/**

* 定時器是否處於停止狀態

* @memberof timer

* @member stopped

* @instance

*/this.stopped = true;

/*** 啟動定時器

* @memberof timer

* @instance

* @method start

* @param handler - 定時器每次執行時呼叫的函式

* @param interval - 定時器執行的時間間隔

*/this.start = function (handler, interval)

_recursion();

}).catch(err => );

}, interval)

}.bind(this);

_recursion();

}/**

* 停止定時器

* @memberof timer

* @instance

* @method stop

*/this.stop = function ()

}/**

* 監聽事件

* @memberof timer

* @instance

* @method on

* @param type - 事件型別 e.g 'stop'

* @param fn - 事件處理函式

* @return eventid - 事件處理函式id,用於取消監聽

*/timer.prototype.on = function (type, fn)

/** * 觸發事件

* @private

*/timer.prototype._trigger = function (type)

}/**

* 取消監聽事件

* @memberof timer

* @instance

* @method off

* @param type - 事件型別 e.g 'stop'

* @param target - 事件處理函式id或者函式名字

*/timer.prototype.off = function (type, target)

規範 前端編碼規範 注釋規範

頂部新增檔案申明資訊,包括檔案描述 原始作者,如果有更新,則需要新增更新內容 更新作者和更新時間。description 說明文字 author 張三 description 說明文字 author 張三 update 更新內容 by 李四 2013 04 13 18 32 無論是單行注釋還是多行注...

C 注釋規範

5.注釋 5.1.注釋的基本約定 注釋應該增加 的清晰度 保持注釋的簡潔,不是任何 都需要注釋的,過多的注釋反而會影響 的可讀性。注釋不要包括其他的特殊字元。建議先寫注釋,後寫 注釋和 一起完成 如果語句塊 比如迴圈和條件分枝的 塊 太長,巢狀太多,則在其結束 要加上注釋,標誌對應的開始語句。如果分...

c 注釋規範

模組開始必須以以下格式編寫模組注釋 模組編號 模組編號,可以引用系統設計中的模組編號 作用 對此類的描述,可以引用系統設計中的描述 編寫日期 模組建立日期,格式 yyyy mm dd 如果模組有修改,則每次修改必須新增以下注釋 log編號 修改描述 對此修改的描述 修改日期 模組修改日期 格式 yy...