访问官网
Github
文档
jsdoc-to-markdown
升级用户请阅读发布说明
jsdoc-to-markdown
从带有 jsdoc 注释的源代码生成 markdown 格式的 API 文档。适用于将 API 文档注入到项目的 README 文件中。
概要
1. 使用有效的 jsdoc 注释来编写代码文档。
/**
* 一个非常棒的函数。
* @param {object} - 隐私斗篷
* @param {object} - 安全武器
* @returns {survival}
*/
function protection (cloak, dagger) {}
2. 运行命令。
$ jsdoc2md example.js
3. 获得 markdown 输出。
## protection(cloak, dagger) ⇒ <code>survival</code>
一个非常棒的函数。
**类型**: 全局函数
| 参数 | 类型 | 描述 |
| ------ | ------------------- | ---------- |
| cloak | <code>object</code> | 隐私斗篷 |
| dagger | <code>object</code> | 安全武器 |
安装
$ npm install --save-dev jsdoc-to-markdown
另请参阅
© 2014-24 Lloyd Brookes <75pound@gmail.com>。
由 test-runner 进行测试。
