类似下划线的 API 文档 [关闭]

Question

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

• underscore
• backbone
• bookshelf

Answer 1

与之前的答案相比，我很确定他们不使用 jsDoc。 Jeremy Ashkenas 也是Docco 的创建者，您仍然可以看到下划线documented with docco。但是主要文档似乎在使用其他东西，而不是 jsDoc。证据很清楚：看源代码，没有jsDoc标签！

除此之外，很明显文档是完全在源代码本身外部生成的。如果您检查 http://underscorejs.org/#chaining，您会看到它包含文本“当您完成计算时”，但在 git 存储库中搜索“计算”时没有找到任何匹配项。

Ashkenas 与DocumentCloud 有一些关系，我对他们了解不多，但我猜想他们宣传的文档注释功能在这里发挥了作用。但我真的不知道。

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