# JS規范及使用工具 ## 一：JS規范 關鍵詞書寫格式為： ``` /** * @author ydr.me * @version 1.0 */ ``` 使用`@key desc`格式來書寫，常用的關鍵詞有： |關鍵詞|描述| | --- | --- | | @auhor|作者| |@param|參數| |@example|示例| |@link|鏈接| |@namespace|命名空間| |@requires|依賴模塊| |@return|返回值| |@version|版本號| ## 二：使用工具-Sublime插件 DocBlockr ### 1、DocBlockr安裝 官方網址：https://github.com/spadgos/sublime-jsdocs/ 在官方的`README.md` 附安裝方法和使用方法。 ### 2、DocBlockr使用 A、先寫完你的函數 ``` function testFunction(a, b, c) { } ``` B、然后在函數的前面一行，輸入 ``` /** ``` C、然后回車，自動生成 ``` /** * [testFunction description] * @param {[type]} a [description] * @param {[type]} b [description] * @param {[type]} c [description] * @return {[type]} [description] */ function testFunction(a, b, c) { } ``` D、并且在注釋塊中，按@鍵可以展開關鍵詞： >注：我這里好像提示不了，如有看到的，請在評論里給予幫助！