VS code 整合JsDoc

Posted 2021-04-30 GeekerNote

VS code 整合JsDoc

JsDoc是一种通过让程序员对JS代码进行预定规则的规范化注释，然后通过命令行生成html API文档集合的工具。

VScode对jsDoc的插件支持，让VScode可以通过jsDoc格式的注释来实现语法提示等功能，进一步加强VScode的使用效能。

优点：

1. 规范了代码的注释，让代码更易于阅读；

2. 增强VScode代码提示，让大项目代码编写更容易；

3. 快速生成API文档，便于查询；

安装JsDoc插件实现代码注释的格式化与JS代码提示

VScode中可以安装JsDoc插件。

安装完插件，就可以在js文件中使用jsDoc语法来实现注释的格式化、规范化与编辑器代码提示。

插入jsDoc注释的语法是shuru/** 插件会自动补全为/** /。

回车确认，jsDoc会根据下方紧邻的function等生成一些参数注释等。

添加完这样的注释，就可以在下方使用时收到代码提示。

生成jsDoc网页文档

为了方便安装和使用jsDoc，直接安装nodeJs。

整合Nodejs

下载安装nodejs

在VS code终端（命令行）中测试和使用nodejs

nodejs安装后，可以直接在VScode自带的命令行（终端）中进行测试和使用；

nodejs安装后需要重启一下VScode才能正常使用nodeJS。

使用npm安装jsDoc

使用npm install jsdoc -g命令安装jsDoc。

U:\codes>npm install jsdoc -g
C:\Users\Administrator\AppData\Roaming\npm\jsdoc -> C:\Users\Administrator\AppData\Roaming\npm\node_modules\jsdoc\jsdoc.js
jsdoc@3.5.5 C:\Users\Administrator\AppData\Roaming\npm\node_modules\jsdoc
├── taffydb@2.6.2
├── escape-string-regexp@1.0.5
├── strip-json-comments@2.0.1
├── underscore@1.8.3
├── babylon@7.0.0-beta.19
├── marked@0.3.19
├── bluebird@3.5.4
├── requizzle@0.2.1 (underscore@1.6.0)
├── js2xmlparser@3.0.0 (xmlcreate@1.0.2)
├── klaw@2.0.0 (graceful-fs@4.1.15)
├── mkdirp@0.5.1 (minimist@0.0.8)
└── catharsis@0.8.9 (underscore-contrib@0.3.0)

U:\codes>

生成API文档

命令行输入jsdoc 1.js命令回车，执行API文档生成；

可以看到jsDoc生成的文档样子比较丑，而且很多英文。