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