네임 스페이스 및 변형 형식의 함수 정의와 함께 JSDOC 사용
-
22-07-2019 - |
문제
나는 JavaScript를 문서화하기 위해 JSDOC를 사용하려고 노력했지만이 장애물을 계속 만나고 있습니다. 그것은 "문서화 할 것이없고, 종료 할 것"이라고 계속 말합니다.
다음은 내가 문서화하려는 코드의 피시입니다.
/**
* Container for all editing methods
* @namespace
*/
var FREdit = {
/**
* Toggle value for editing
* @type Number
*/
isToggleOn:0,
/**
* Initialize editing
*/
init: function(){
this.initPopups();
},
/**
* Function to enable editing
*/
enable: function(){
this.enableTitles();
this.isToggleOn = 1;
}
};
위에는 네임 스페이스를 사용하고 있습니다. JavaScript에서 변형 형식의 함수 정의를 사용하더라도 JSDOC는이를 인식하지 못하는 것 같습니다. 예 :
/**
* Just any function
*/
var any_function = function(){
};
이 문제를 해결하는 방법이 있습니까? 감사!
해결책
당신의 질문에서 판단하면 나는 당신이 JSDOC를 사용하고 있다고 생각합니다. 원래 JSDOC는 한동안 지원되지 않았습니다.
나는 당신이 사용하는 것이 좋습니다 JSDOC-TOOLKIT 훨씬 더 나은 지원을 가지고 있기 때문에. 그들의 문서에 따르면 당신은 할 수 있습니다 클래스 패턴을 문서화하십시오. 그들의 예를 살펴 보면 가면 좋을 것입니다!
건배!
제휴하지 않습니다 StackOverflow