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 con fig uration 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
网站描述: 一个 JavaScript 自动 生成 接口文档
esdoc官方网站
官方网站: https://github.com/esdoc/esdoc
如果觉得 网站内容还不错,欢迎将 网站 推荐给程序员好友。