文件名称：jsdoc-to-markdown：从jsdoc注释的javascript生成markdown文档
文件大小：31KB
文件格式：ZIP
更新时间：2024-02-24 07:03:49
markdown readme documentation generator jsdoc
升级程序，请阅读
jsdoc到markdown
从注释的源代码生成markdown API文档。 对于将API文档注入项目自述文件很有用。
概要
1.使用有效的jsdoc注释记录代码。
/**
* A quite wonderful function.
* @param { object } - Privacy gown
* @param { object } - Security
* @returns { survival }
*/
function protection ( cloak , dagger ) { }
2.运行命令。
$ jsdoc2md example.js
3.获取降价输出。
## protection(cloak, dagger) ⇒ survival
A quite wonderful function.
**Kind** : global function
| Param | Type | Description |
| ------ | -------------------
【文件预览】：
jsdoc-to-markdown-master
----lib()
--------dmd-options.js(212B)
--------jsdoc-options.js(183B)
--------cli-data.js(7KB)
----.travis.yml(48B)
----LICENSE(1KB)
----test()
--------sync.js(2KB)
--------async.js(4KB)
--------fixture()
--------cli.js(925B)
----README.md(2KB)
----docs()
--------API.md(10KB)
----.gitignore(54B)
----index.js(8KB)
----bin()
--------cli.js(2KB)
----package-lock.json(56KB)
----package.json(1KB)