我怎样才能创build像underscore.js注释的源代码？

我绝对喜欢underscore.js库附带的带注释的源代码 ：

1. 他们是怎么做到的？
2. 是否有一个脚本，将拉出代码的意见，并自动创build这种types的HTML文档？

Answer 1

似乎是Docco ： http : //jashkenas.github.com/docco/

---

来自网站：

“Docco是一个快速而肮脏的，长达百年的文字编程风格的文档生成器，它生成的HTML会在您的代码旁边显示您的评论，评论通过Markdown传递，代码通过Pygments语法突出显示。 ……”

Answer 2

ExplainJS.com为你做。 只需粘贴到您的源代码的URL，它很好地呈现在HTML中。

如果您只想要原始数据，也可以使用.json选项：

 > curl http://explainjs.com/explain.json?src=http://cdnjs.cloudflare.com/ajax/libs/backbone.js/1.0.0/backbone.js { "src": "http://cdnjs.cloudflare.com/ajax/libs/backbone.js/1.0.0/backbone.js", "title":"backbone.js", "sections": [ { "comments":"<p>Backbone.js 1.0.0</p>", "code":"" }, ... ] } 

完全披露：我build立了这个网站，但它是免费的服务。

Answer 3

还有.NET的nocco ，shell的shocco ，python的pycco ，ruby的rocco 。

Answer 4

斯卡拉有Circumflex Docco 。 你可以在这里find一个生成文档的例子。