JSDoc 的簡易寫作說明
jsdoc jsdoc -JSDoc 註釋範例，以註釋的方式放在函數上方，用來說明函數的使用方法、參數、返回值等資訊。以下是各個欄位的說明：
How
function
去掉與物件導向相關和寫作資訊，只說明與函數比較會用的使用方法、參數、返回值等有關的欄位資訊。以下是各個欄位的說明：
-
@alias: 別名，可視為有不同的名稱。
-
@async: 異步，表示函數是異步的。
-
@callback: 回呼，描述回調函數。
-
@deprecated: 棄用，用於表明該方法或屬性已經過時或不再使用。
-
@description (synonyms: @desc): 說明用，描述一個符號。
-
@example: 範例，提供如何使用的示範舉例。 @function (synonyms: @func, @method): 函式，用於描述函數或方法。
-
@param (synonyms: @arg, @argument): 參數，用於描述一個函數的參數。
-
@returns (synonyms: @return): 返回，用於描述一個函數的返回值。
-
@see: 參考，可參考哪些資源。
-
@since: 自從，描述從哪一個版本開始。
-
@summary: 摘要，用於描述一個符號的摘要。
-
@throws (synonyms: @exception): 拋出，用於描述一個函數可能拋出的異常。
-
@todo: 待辦，用於描述一個待辦事項。
閱讀在雲端 