JSDoc JS-툴킷에 다음 함수를 문서화하는 방법

Question

* JSDoc JS-툴킷 *에 다음 함수를 문서화하는 방법 내가 이 주요 기능 에 및 도움을 방법을 시도 문서화 할

그러나 나는 그것을 어떻게하는지 이해하지 못했습니다.

/** Sample doc 
* @class 
* @constructor 
* @name Sample 
*/ 
var main=function(){ 
    this.value=""; 

    /** help function 
    * @param {String} Name 
    */ 
    this.help=function(name){ 
    console.log('help me'+name); 
    } 

    /** help function 
    * @param {String} Name 
    */ 
    this.try=function(name){ 
    console.log('try me'+name); 
    } 

} 

Answer 1

방금 ​​몇 시간 동안 고민했습니다. I 시도 : 예 및 I 발견 튜토리얼 멤버 함수 및 변수와

• @member
• @augments
• @method
• @this

가 갖는 것만으로 출력에 표시해야 위의 내용은 /** description/*이지만, 사실이 아닌 것으로 나타났습니다. 여러분도 마찬가지로 표준 JavaScript 생성자를 사용하고 있습니다. this은 @constructor이 자동으로 유추 될 수 있어야합니다. 어쩌면 내가 보지 못하는 주름살이있을 수 있습니다.

결국, 나를 위해 일한 두 개의 태그, @name 및 @memberof을 발견했습니다. 둘 다 속성이 속한 개체를 지정할 수 있습니다. 이 방법으로 @name을 사용하면 문서화되지 않았습니다 (적어도 필자는 아무데도 보지 못했지만). @function을 사용해야합니다. 여기

는 @name 태그 예제 :

/** help function 
* @name Sample.try 
* @function 
* @param {String} Name 
*/ 
this.try=function(name){ 
    console.log('try me'+name); 
}; 

그리고 여기 @memberof 태그 예입니다 :

/** help function 
* @memberof Sample 
* @function 
* @param {String} Name 
*/ 
this.try=function(name){ 
    console.log('try me'+name); 
}; 

당신이 볼 수 있듯이 출력은 거의 동일합니다. 유일한 차이점은 메서드 이름에 @memberof에 this.이 포함되어 있다는 것입니다. 그런 이유로 나는 @name을 사용하여 정착했습니다.

나머지 문제는 해당 기능이 인스턴스 단위가 아니라 <static>입니다.

희망이 도움이됩니다.