类似下划线的API文档

时间:2014-06-26 20:20:49

标签: javascript backbone.js documentation underscore.js

下划线作者是否使用任何特定工具来生成文档?我想是因为我发现至少有三个项目以相同的方式记录,但我找不到任何这些项目所使用的工具的任何信息。

1 个答案:

答案 0 :(得分:5)

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

不仅如此,很明显,文档完全是在源代码本身外部生成的。如果你检查http://underscorejs.org/#chaining,你会看到它包含文本“当你完成计算时”,但搜索git repo的“计算”没有找到命中。

Ashkenas与DocumentCloud有一些关系,我对它们知之甚少,但我猜这里有关于他们广告文档注释功能的一些信息。但我真的不知道。

我希望我这样做,因为我比其他许多人更喜欢Underscore / Backbone文档,而且我有一个越来越受欢迎的项目,但实际上需要的文档不仅仅是我们现在拥有的Docco