jsdoc-前端文档注释利器入门教程

为什么选择jsdoc

就前端的api接口文档而言，不像后端是通过调用服务的形式；我们更关注的是一个函数的使用方法；类似于javadoc，jsdoc则专门是为前端而生的一款前端api文档。

是什么样的

这里截了图，简单的测试下，可见，界面布局和解释，是很满足前端要求的。

安装步骤

1 环境要求

这里要先安装nodejs，这里请大家自行百度解决

2 全局安装jsdoc

npm install -g jsdoc

针对于项目管理者或者个人，都建议全局安装；因为本地安装需要解决路径依赖（即环境变量问题）

3 本地安装

npm install --save-dev jsdoc

安装后的运行目录位置在：./node_modules/.bin/jsdoc

使用

这里我给大家搭建了一个测试环境
然后用命令生成文档

然后就多了一个文件夹；
这里需要注意以下几点：

1 如果你是本地安装的，运行jsdoc会报错的，两种解决办法；（1）全局安装 （2）设置环境变量 （3）去jsdoc的bin目录下执行jsdoc
2 命令的起始目录是当前命令行显示的目录，比如，我的命令行目录是vueDemo,那么我执行jsdoc test.js，他就可是找到test.js，如果vueDemo里没有test.js，是找不到的。

使用配置文件执行

json配置文件

{
   
   
    "tags": {
   
   
        "allowUnknownTags": true
    },
    "source": {
   
   
        "include": ["Demo/"],
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_",
        "exclude": ["./src/index.js"]
    },
    "plugins": [],
    "opts": {
   
   
        "encoding"