1

YUIdoc では、読み取り専用の計算されたプロパティ (たとえば、Ember.js モデルの) をどのように文書化する必要がありますか?

単純なモデルがあるとします:

/**
 * Person model
 * @class Person
 * @extends Ember.Object
 * @constructor
 */
Person = Ember.Object.extend({
  /**
   * @property firstName
   * @type String
   */
  firstName: null,

  /**
   * @property lastName
   * @type String
   */
  lastName: null,

  /**
   * ? what goes here?
   */
  fullName: Ember.computed('firstName', 'lastName', function() {
    return `${this.get('firstName')} ${this.get('lastName')}`;
  })
});

何をfullNameマークする必要がありますか？

それは@propertyですか？もしそうなら、それはとしてマークされるべき@readOnlyですか？セッター関数がないため、読み取り専用のプロパティです。一方、編集可能/設定可能なプロパティから派生しているため、ユーザー アクションの結果として変更される可能性があります。

それとも@methodですか？他のプロパティを使用するだけでなく、実際にそれらを変換するためですか? 変換の部分は、このような単純な例では明らかではありませんが、計算されたプロパティが のようなものnameInitialsで、姓と名の最初の文字のみを返すなどとしましょう。

@propertyまた:タグではなく、Ember プロパティのタグを使用するのは正しい@attributeですか?

4

3 に答える 3

1

これがあなたがここに持つべきものだと思います：

@property fullName
@type String
@final

タグは のみを使用@finalしてください。@readonlyattributes

于 2016-06-23T10:44:12.080 に答える
0

ember.js ソース コードでは、@method ではなく @property を使用しています。

例: https://github.com/emberjs/ember.js/blob/ae6c9e82b91fd5b695907e7b76c998a128a157d0/packages/ember-views/lib/views/text_field.js#L108

于 2015-09-24T20:08:56.143 に答える