如何记录Ember App？

Question

我正在使用YUIdoc.还要别的吗 ？那么有人能告诉我如何在Ember中正确记录模型,控制器,混合和视图吗？

例如,我试图记录这个:

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

您将很难使用JSDoc for Ember应用程序,因为JSDoc解析代码而不仅仅是注释.Ember使用他们自己的类类语法,因此JSDoc无法识别很多代码.我个人使用YUIDoc,这是Ember团队使用的.(YUIDoc还允许您导入其他文档来解析外部引用,例如DS.Model.)还有其他选择.此页面进行了一些比较,并为您提供了一个差异图表,显示哪些工具解析注释而不是源代码.

此外,我意识到我没有回答你的具体问题.但这应该有助于回答有什么替代方案的问题,这可能完全消除你的JSDoc问题.