2014-06-26 48 views
3

是否有任何由下划线作者用于生成文档的特定工具?我想这样做是因为我发现至少有三个以相同风格记录的项目,但我找不到任何有关这些项目使用的工具的任何信息。类似于下划线的API文档

+0

我不知道是否存在,但backbone.js和underscore.js都是由同一个人创建的([Jeremy Ashkenas](http://ashkenas.com/))。 – Jack

+0

也许它只是相同的html模板。或者Jeremy Ashkenas使用一些引擎来生成静态HTML。像jekyll或类似的东西.. – rcarvalho

回答

4

与以前的答案相反,我敢肯定,他们不使用jsDoc。 Jeremy Ashkenas也是Docco的创建者,你仍然可以看到下划线documented with docco。但主要文档似乎在使用别的东西,而不是jsDoc。证据很明确:查看源代码,并且没有jsDoc标签!

不仅如此,文档也完全由源代码本身生成。如果您检查http://underscorejs.org/#chaining,您会看到它包含文本“当您完成计算”时,但在“计算”中搜索git回购没有找到命中。

Ashkenas与DocumentCloud有一些关系,我对它们的了解不多,但我猜测他们的广告文档注释功能在这里。但我真的不知道。

我希望我这样做,因为我比其他许多人更喜欢Underscore/Backbone文档,而且我有一个越来越流行的项目,但真的需要一些体面的文档,而不仅仅是我们现在的Docco