# 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、并且在注释块中，按@键可以展开关键词： >注：我这里好像提示不了，如有看到的，请在评论里给予帮助！