带有轻量级标记的Javascript API文档框架

Question

我正在寻找一个Javascript API文档框架，具有类似于JSDoc的功能，但会在代码注释(不是html)中使用易于输入的重构文本或标记

奖励:可以很好地与Sphinx集成。但是，我不想维护单独的文档，而是从注释中生成API文档。

http://code.google.com/p/jsdoc-toolkit/

Answer 1

我终于找到了最适合这个任务的JSDuck:

https://github.com/senchalabs/jsduck

Answer 2

invislejs支持降价和其他多种格式。

还可以看看docco.

Answer 3

JSDoc 3现在支持插件降价。您可以通过添加

行来配置降价支持

"plugins": [ "plugins/markdown" ],

到你的配置JSON文件

现在，使用-c conf.json启动JSDoc将启用降价支持。

Answer 4

对于那些还在为jsdoc-toolkit寻找降价插件的人，请看看下面链接中名为" smartdown "的插件

https://github.com/sproutcore/docs

(更多语法参考:http://guides.sproutcore.com/documentation_guidelines.html)

我通过以下模板(jsdoc-toolkit-rst-template, jsdoc-for-sphinx)对sphinx进行了测试，它可以完美地工作。

Answer 5

对于非常轻量级的标记，请查看yamdog。它为Markdown和YAML解析注释块。与基于javadoc的替代品(如JSDoc和Dox)不同，yamdog没有任何神奇的关键字需要您记忆。因此，它可以防止注释开始看起来像另一种代码。它可能不像JSDoc那样功能丰富和集成良好，但它仍然可以完成工作并保持简单。不幸的是，Sphinx集成目前还没有出现在路线图上。免责声明:我是维护人员。

下面是一个来自tapspace库的yamdog注释块的例子:

// tapspace.Point:polarOffset(distance, angle)
//
// Get the point at the given *distance* at the *angle*.
//
// Parameters:
//   distance
//     a number on the basis or a Distance.
//   angle
//     a number in radians on the basis or a Direction.
//
// Return
//   a Point
//

yamdog只需要注释块以一个特定的字符串开始，比如"tapspace"在这种情况下。其余部分取决于您，只要它是有效的YAML/Markdown。键入Markdown也可能很乏味，所以请参阅yamdog装饰器，了解包含目录、自动链接等的简单方法。