ここでは、例としてemberJSコントローラがあります。 YUIDocを使ってドキュメントを生成するには、正しくコメントする方法は?YUIDoc、コメントスタイルを使用したEmberJSドキュメント?
import Ember from 'ember';
/**
* ?
*/
export default Ember.Controller.extend({
queryParams: ['param1', 'param2'],
/**
* ?
*/
param1: '',
/**
* ?
*/
param2: 10,
/**
*
*/
testFunc1(param) {
},
/**
*
*/
actions: {
/**
* ?
*/
testFunc2(id) {
},
/**
* ?
*/
testFunc3() {
/**
* ?
*/
function testFunc4() {
}
}
}
});
私はemberJSコードのドキュメントのためのベストプラクティスを知って興味を持っているので、最後に、私は完全な階層で適切なDOCOを得ることができます。どんな助けも高く評価されます。
私は、アクションとアクションクロージャに '@ method'を使用する傾向があります。私はまた、自分自身のコンポーネント/コントローラのテンプレートや内部使用を '@ private'としてタグ付けしているプロパティやメソッドにタグを付ける傾向がありますが、プロパティとアクションクロージャでは' @ public'として動作するアプリケーションを期待しています。 – Sukima