ember.js - 如何记录 Ember 应用程序？

Question

我正在使用 YUIdoc。还要别的吗 ？那么谁能告诉我如何在 Ember 中正确记录模型、 Controller 、mixin 和 View ？

例如，我正在尝试记录这一点:

App.newModel = DS.Model.extend({
    someProperty: DS.attr('string')
});

App.myController = Ember.Controller.extend({
    someProperty: ...
});

App.myMixin = Ember.Mixin.create({
    someProperty: ...
});

编辑我现在使用 YUIdoc 而不是 jsdoc3

Answer 1

在 Ember 应用程序中使用 JSDoc 会很困难，因为 JSDoc 解析代码而不仅仅是注释。 Ember 使用自己的类似类的语法，因此 JSDoc 无法识别很多代码。我个人使用YUIDoc ，这是 Ember 团队使用的。 (YUIDoc 还允许您导入其他文档来解析外部引用，例如 DS.Model。)不过还有其他替代方案。 This page进行一些比较，并为您提供一个差异图表，显示哪些工具解析注释而不是源代码。

此外，我意识到我没有回答您的具体问题。但这应该有助于回答有哪些替代方案的问题，这可能会完全消除您的 JSDoc 问题。