예를 들어 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 코드 문서에 대한 모범 사례를 알고 싶으므로 결국에는 완전한 계층 구조로 올바른 문서를 얻을 수 있습니다. 어떤 도움을 주시면 감사하겠습니다.
나는 액션과 액션 클로저에'@ method'를 사용하는 경향이 있습니다. 필자는 자신의 구성 요소/컨트롤러 템플릿이나 내부 사용을'@ private'로하는 모든 속성이나 메서드에 태그를 붙이는 경향이 있습니다. 속성과 액션 클로저는 응용 프로그램이'@ public'으로 작동 할 것으로 기대합니다. – Sukima