# 前言

JSDoc 是一个根据 Javascript 文件中注释信息，生成 JavaScript 应用程序或库、模块的 API 文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等。

JSDoc 可以帮助开发者将标准化的注释转化为文档，协同开发其他开发者可以快速了解整个类和其中的属性和方法，并且快速知道如何使用，从而提高开发效率，降低维护成本。

# Jsdoc开发环境地址

源码地址：github.com/dkypooh/fro…

Jsdoc脚手架地址：github.com/ge-tbms/gen…

# 安装

$ npm i jsdoc -g

# 主题及配置

JSDOC 提供很多丰富的主题 (主题资源列表), 本章以 DocStrap 主题为例，它是以 Bootstrap 样式为原型。

$ npm i ink-docstrap -D // 主题安装

# 配置信息

参考