JSDoc 3

JSDoc 3 介绍

jsDoc 3是一款根据 JavaScript 文件 中注释信息， 生成 JavaScript 应用、库、模块的 API 文档的工具。你可以使用它记录如：命名空间、类、 方法 、 方法 参数等。该项目还衍生出了许多模板和其他工具来帮助 生成 和 自定义 文档?

安安装jsDoc

npm i jsdoc -g

如何使用jsDoc

同其他语言一样，文档 生成 工具的原理还是通过 代码 注释去解析并根据一定的tag来 生成 文档。在jsDoc文档中明确说明了，只有以/**为开始的注释才会被jsDoc识别，其他的注释格式都会被忽略。

额外，jsDoc 默 认还会将项目中的README.md 文件 一同 生成 到jsDoc最后 生成 的文档 文件 中，或通过命令--R/-readme 指定个别 文件 ，将其 添加 至所 生成 的文档 文件 中，但 文件 格式必须是Markdown，此时，项目中的README.md将被忽略。

jsDoc命令行参数

jsDoc命令行几个常用参数有以下几个：-c,--con fig ure 指定con fig uration file-d,--destination 指定 输出 路径， 默 认./out-e,--encoding 设定encoding， 默 认utf8-p,--private 将private注释 输出 到文档， 默 认不 输出 -P,--package 指定package.json file-r,--recurse 查询 子目录-t,--template 指定 输出 文档template-u,--tutorials 指定教程路径， 默 认无

JSDoc 配置文件

同许多js工具一样，JSDoc也有 配置文件 ，可以通过设定 配置文件 来定制JSDoc。如果没有指定con fig uration file，将会使用一下配置。{"tags": {"allowUnk Now nTags": true,// 允许使用 自定义 tag"dictionaries": ["jsdoc","closure"] // 定义tag集},"source": {"includePattern": ".+\.js(doc)?$",// 将以.js,.jsdoc结尾的 文件 作为源 文件 "excludePattern": "(^|\/|\\)_" // 忽略以_开头的 文件 夹及 文件 },"plugins": [],"templates": {"c Lever Links": false,"monospaceLinks": false}} 链接 : http://www.fly63.com/nav/991

网站地址 : http://usejsdoc.org

GitHub: https://github.com/jsdoc3/jsdoc

网站描述: 生成 javascript api文档

JSDoc 3官方网站

官方网站： http://usejsdoc.org

如果觉得 网站内容还不错，欢迎将 网站 推荐给程序员好友。

查看更多关于JSDoc 3的详细内容...