利用JS注释自动生成api文档神器 — jsdoc

利用JS注释自动生成api文档神器 — jsdoc

安装

1、第一种方法:全局安装jsdoc:

npm install -g jsdoc

2、第二种方法:cd到项目路径下,在项目中局部安装 jsdoc:

npm install --save-dev jsdoc

参考 :https://github.com/jsdoc/jsdoc

运行

1、全局安装jsdoc时运行:

jsdoc 你的js文件.js

2、局部安装 jsdoc时运行:

./node_modules/.bin/jsdoc 你的js文件.js

运行后生成文件
运行后生成文件结构

注释文档格式

参考 :https://www.html.cn/doc/jsdoc/tags-author.html

js中注释写法
在这里插入图片描述

api文档生成后的格式
在这里插入图片描述