我正在寻找一个 Javascript API 文档框架,其功能类似于 JSDoc,但会在代码注释(不是 html)中使用易于键入的重组文本或 markdown
奖励:将与 Sphinx 很好地集成。但是,我不想维护单独的文档,而是从注释中生成 API 文档。
我正在寻找一个 Javascript API 文档框架,其功能类似于 JSDoc,但会在代码注释(不是 html)中使用易于键入的重组文本或 markdown
奖励:将与 Sphinx 很好地集成。但是,我不想维护单独的文档,而是从注释中生成 API 文档。
我终于找到了最适合这个任务的 JSDuck:
InvisibleJS支持 markdown 和各种其他格式。
也看看docco。
JSDoc 3 现在通过插件支持降价。您可以通过添加行来配置降价支持
"plugins": [ "plugins/markdown" ],
到您的配置 JSON 文件。
现在,启动 JSDoc-c conf.json
将启用降价支持。
对于那些仍在寻找 jsdoc-toolkit 的 markdown 插件的人,请在以下链接中查看名为“smartdown”的插件
https://github.com/sproutcore/docs
(更多语法参考:http: //guides.sproutcore.com/documentation_guidelines.html)
我通过以下模板(jsdoc-toolkit-rst-template、jsdoc-for-sphinx)在 sphinx 上进行了尝试,它完美地工作。