javascript - 类似下划线的 API 文档

标签 javascript backbone.js documentation underscore.js

<分区>

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

最佳答案

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

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

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

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

关于javascript - 类似下划线的 API 文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24439513/

相关文章:

netbeans - 可以在 NetBeans 中查看方法/函数文档吗?

c++ - 在代码中管理大量文本(并支持翻译)的最佳方式是什么?

javascript - 从具有共同属性的 html 元素列表到它们的值数组?

javascript - 使用Javascript替换具有相同ID的所有innerHTML

javascript - 在 Backbone 应用程序的渲染功能上使用 addClass() 和 CSS transition 无法正常工作

collections - 在主干集合上使用下划线方法 'find'

javascript - 谷歌地图保存可拖动的方向

javascript - 我可以使用 jQuery globaleval 而不是 eval 来逃避内容安全策略吗

javascript - Backbone Marionette 'itemViewContainer' 未找到

MATLAB 不显示用户创建的类私有(private)方法和属性的帮助