mdextract:将**代码注释*提取到Markdown文档中

时间:2024-07-16 16:29:57
【文件属性】:

文件名称:mdextract:将**代码注释*提取到Markdown文档中

文件大小:14KB

文件格式:ZIP

更新时间:2024-07-16 16:29:57

JavaScript

提取物 从代码文件中提取/** code comments */并将它们转换为 Markdown 文档。 支持 JavaScript 风格的注释(其他语言即将推出)。 $ npm install -g mdextract $ mdextract --help 给定任何嵌入在/** comments */ Markdown 代码: /** * ## API * This is the API. (...) */ function api ( ) { ... } 使用它将评论提取到文档中: $ mdextract file.js > docs.md 瞧! $ cat docs.md ## API This is the API. (...) $ 例子 来自 mdextract 的 () 从读取输入()读取输入输入 从Navstack() 更新模式 您可以将<!--


【文件预览】:
mdextract-master
----.gitignore(13B)
----test.md(62B)
----bin()
--------mdextract(2KB)
----test()
--------mocha.opts(58B)
--------matcher_test.coffee(5KB)
--------internal_test.coffee(2KB)
--------todo.coffee(302B)
--------basic_test.coffee(1KB)
--------setup.coffee(253B)
--------process_text_test.coffee(3KB)
----History.md(162B)
----Notes.md(86B)
----Readme.md(3KB)
----package.json(568B)
----index.js(8KB)
----Makefile(40B)
----lib()
--------matcher.js(4KB)
--------transforms.js(2KB)
----API.md(2KB)

网友评论