0 环境

本文档采用npm版本为6.11.3

jsdoc官网

1 使用NPM安装JSDoc

首先，新建一个工程目录，不妨为jsdoc_demo。创建完成后进入目录

执行

npm init -y

生成一个package.json文件

安装jsdoc

npm i -D jsdoc

package.json中会新增开发依赖配置项

2 配置

jsdoc需要一个配置文件，如果你不创建它，jsdoc会使用默认值

首先，在工程根目录创建一个文件jsdoc.json，并从官网复制默认内容进去

{"plugins": [],"recurseDepth": 10,"source": {"includePattern": ".+\\.js(doc|x)?$","excludePattern": "(^|\\/|\\\\)_"},"sourceType": "module","tags": {"allowUnknownTags": true,"dictionaries": ["jsdoc","closure"]},"templates": {"cleverLinks": false,"monospaceLinks": false}
}

具体配置项请阅读官网配置说明，本文档不深究配置项。下面对该配置文件进行修改，修改后如下

{"plugins": ["plugins/markdown"],"source": {"include": ["src"],"includePattern": ".js$","excludePattern": "(node_modules/|docs)"},"sourceType": "module","templates": {"cleverLinks": true,"monospaceLinks": true},"opts": {"recurse": true,"destination": "./docs/"}
}

打开package.json文件，添加执行脚本，下面是脚本添加后的内容

 "scripts": {"test": "echo \"Error: no test specified\" && exit 1","doc": "jsdoc -c jsdoc.json"},

3 测试

按照配置，我们需创建名为src的源文件夹，该文件夹中的js文件将会自动生成文档。

我们在src下直接创建一个index.js文件。此时，文件中没有内容，但我们可以直接执行脚本测试。

执行

npm run doc

我们会发现工程根目录下多了一个docs文件夹，这是jsdoc按照配置文件的配置生成的。进入docs文件夹，直接打开index.html查看效果

文档成功生成，但除了模板啥内容没有

我们在index.js中添加一些内容

// @ts-check/*** Student Name* @type {string}*/
const studentName = 'John Doe';

然后再次执行生成文档的脚本，看下效果

完结。后面的开发按照规范写注释，即可快速生成文档。

jsdoc安装与配置相关推荐

JSDoc 安装教程
环境 nodeJs v10.17.0 jsdoc v3.6.3 操作说明全局安装jsdoc最新版 npm install jsdoc -g 全局安装jsdoc 指定v3.6.3版本 npm inst ...
Maven安装与配置（最实用！！！）eclipse中配置maven
Maven安装与配置一.需要准备的东西 JDK Eclipse(本章主要是在eclipse中进行配置maven) Maven程序包二.下载与安装 1. 前往maven下载最新版的Maven程序: ...
Portainer 安装与配置
文章目录 Portainer 安装与配置一.介绍二.安装使用 1.单机运行 2.基于swarm集群方式运行 Portainer 安装与配置一.介绍 Portainer 是一个开源.轻量级Do ...
Myeclipse安装、配置、测试
Myeclipse安装.配置.测试(win7_64bit) 目录 1.概述 2.本文用到的工具 3.安装与激活 4.JavaSE开发测试(确保JDK已正确安装) 5.JavaEE开发测试(确保服务器和 ...
[网摘学习]在Ubuntu上安装和配置OpenStack Nova之二
再收藏一份Openstack的文章,这两天的操作与此相同.但其中出现的问题还需要查找原因.待个人继续学习研究. 原文参考:http://www.linuxde.net/2011/11/1599.htm ...
centos6.5 php5.2,Linux中PHP安装与配置(CentOS-6.5：php-5.2.13)
1 PHP简介 PHP(PHP: Hypertext Preprocessor的缩写,中文名:"超文本预处理器")是一种通用开源脚本语言.语法吸收了C语言.Java和Per ...
java jdk 1.8 安装_下载、安装、配置 java jdk1.8
近期配置react native的开发环境,所以就从配置环境开始.rn的环境配置有那么几项,其中重要的一个就是java jdk(Java Development Kit 的缩写),那么以下就是下载.安 ...
mysql安装好需要优化配置一下_Mysql的安装、配置、优化
Mysql的安装.配置.优化安装步骤 1.先单击中的安装文件,如果是win7系统,请选择以管理员的方式运行. 2.大概需要30秒的时间,开始进入安装界面.请先把标红的打勾,好进行下一步的动作. 3. ...
windows下opencv安装及配置（vs2010环境）
opecv下载前往官方下载地址 https://opencv.org/releases/ opencv安装及配置解压,会得到一个opencv文件夹,可将提取出的文件移动到任意位置,我将其放在F盘. ...

jsdoc安装与配置

0 环境

1 使用NPM安装JSDoc

2 配置

3 测试

jsdoc安装与配置相关推荐

最新文章

热门文章