問題タブ [yuidoc]

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

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

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

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

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

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

YUIdoc のドキュメント (この場合は jsdoc と同等のようです) によると、スローされる可能性のあるエラーを説明する @throws タグがあります。

メソッドがスローするエラーを指定します。@throws タグには、構造 @throws {type} description があります。{type} はオプションです。

私の場合、エラーをスローする可能性のある関数にいくつかのチェックがあるため、@throws でそれらをリストしたいと思います。ただし、複数の @throws タグを使用することはできません。では、スローされる可能性のあるエラーのリストをこのタグに入れるにはどうすればよいでしょうか?

ここでは、例として emberJS コントローラーを使用します。YUIDoc を使用してドキュメントを生成するために適切にコメントする方法は?

私は emberJS コード ドキュメントのベスト プラクティスを知りたいと思っているので、最終的には完全な階層を持つ適切な doco を取得できます。どんな助けでも大歓迎です。