扫一扫分享
ESDoc 是一个根据 javascript 文件中注释信息,生成 JavaScript 应用程序或库、模块的 api 文档的工具。具有文档覆盖率统计、系统手册、一体化测试、详细接口说明等特点。它可以将测试代码和用户手册一并集成到文档中,支持通过插件添加自定义功能。
// 安装
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
仅供个人学习参考/导航指引使用,具体请以第三方网站说明为准,本站不提供任何专业建议。如果地址失效或描述有误,请联系站长反馈~感谢您的理解与支持!
手机预览