13

私はYUIdocを使用しています。他に何か ？Ember でモデル、コントローラー、ミックスイン、およびビューを適切に文書化する方法を誰か教えてもらえますか?

たとえば、私はこれを文書化しようとしています:

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

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

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

編集現在、jsdoc3 の代わりに YUIdoc を使用しています

4

2 に答える 2

10

JSDoc はコメントだけでなくコードを解析するため、Ember アプリケーションに JSDoc を使用するのは難しいでしょう。Ember は独自のクラスに似た構文を使用するため、JSDoc は多くのコードを認識できません。私は個人的に Ember チームが使用しているYUIDocを使用しています。(YUIDoc では、他のドキュメントをインポートして、 などの外部参照を解決することもできますDS.Model。) ただし、他の代替手段があります。このページでは比較を行い、どのツールがソース コードではなくコメントを解析するかを示す差異チャートを提供します。

また、私はあなたの特定の質問に答えていないことを認識しています. しかし、これは、JSDoc の質問を完全に排除する可能性がある代替手段についての質問に答えるのに役立ちます。

于 2014-05-06T12:40:09.743 に答える