1
這裏我以一個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。任何幫助將不勝感激。
我傾向於將@方法用於動作和動作關閉。我還傾向於將屬於我自己的組件/控制器模板或內部使用的任何屬性或方法標記爲「@ private」,而屬性和動作關閉期望我的應用程序以'@ public'的方式工作。 – Sukima