esdoc 介绍
esdoc 是一个根据 JavaScript 文件中注释信息，生成 JavaScript 应用程序或库、模块的 API 文档的工具。具有文档覆盖率统计、系统手册、一体化测试、详细接口说明等特点。它可以将测试代码和用户手册一并集成到文档中，支持通过插件添加自定义功能。
esdoc安装使用
// 安装
npm install --save-dev esdoc esdoc-standard-plugin
// 使用
./node_modules/.bin/esdoc
案例
# Move to a your project directory.
cd your-project/
# Install esdoc and standard plugin.
npm install --save-dev esdoc esdoc-standard-plugin
# Create a configuration file.
echo '{
"source": "./src",
"destination": "./docs",
"plugins": [{"name": "esdoc-standard-plugin"}]
}' > .esdoc.json
# Run esdoc.
./node_modules/.bin/esdoc
# View a documentation
open ./docs/index.html
网站地址:https://github.com/esdoc/esdoc
GitHub:https://github.com/esdoc/esdoc
esdoc
官方网站：https://github.com/esdoc/esdoc
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 [email protected] 举报，一经查实，本站将立刻删除。