JS代碼註釋規範
基本參數
- @param @argument 指定參數名和說明來描述一個函數參數
- @returns 描述函數的返回值
- @author 指示代碼的作者
- @deprecated 指示一個函數已經廢棄，而且在將來的代碼版本中將徹底刪除。要避免使用這段代碼
- @see 創建一個HTML鏈接，指向指定類的描述
- @version 指定發佈版本
- @requires 創建一個HTML鏈接，指向這個類所需的指定類
- @throws @exception 描述函數可能拋出的異常的類型
{@link} 創建一個HTML鏈接，指向指定的類。這與@see很類似，但{@link}能嵌在註釋文本中 - @fileoverview 這是一個特殊的標記。如果在文件的第一個文檔塊中使用這個標記，則指定該文檔塊的餘下部分將用來提供這個文件的概述
- @class 提供類的有關信息，用在構造函數的文檔中
- @constructor 明確一個函數是某個類的構造函數
- @type 指定函數的返回類型
- @extends 指示一個類派生了另一個類。JSDoc通常自己就可以檢測出這種信息，不過，在某些情況下則必須使用這個標記
- @private 指示一個類或函數是私有的。私有類和函數不會出現在HTML文檔中，除非運行JSDoc時提供了–private命令行選項
- @final 指示一個值是常量值。要記住JavaScript無法真正保證一個值是常量
- @ignore JSDoc忽略有這個標記的函數
參考：https://segmentfault.com/a/1190000015204718
參考：https://juejin.im/entry/599d433cf265da24797b5c66