2013-12-18 4 views
0

John Resig의 Class extend을 사용하여 구성 요소 세트를 작성하고 있습니다. JsDoc을 사용하여 설명서를 작성하고 있습니다. 다음과 같이 "클래스"를 만들면 :JsDoc이 클래스를 두 배로 만듭니다.

JsDoc은 예상대로 작동하며 문서에 클래스를 만듭니다.

내가 존의 확장 사용하여 하나를 만들 :

/** 
* Tests a thing to see what it is, baby 
* @constructor 
    */ 
TestThing2 = Class.extend({ 

    /** 
     * Creates another thing 
     * @constructs TestThing2 
     * @param {number} id 
     */ 
    init: function(id) { 
     /** 
      * The thing's id 
      * @type {string=} 
      */ 
     this.Id = id; 
    }, 

    /** 
     * Gets the thing 
     * @param {number} id 
     * @returns {number} 
     * @memberof TestThing2 
     */ 
    Get: function(id) { 
     return 5 
    } 
}) 

내가 같은 페이지에서 클래스의 두 버전의 문서를 얻을, 생성자 인수없이 첫 번째 (그래서 새로운 TestThing2()를) 및 두 번째 인자 (new TestThing2 (id)).

분명히 나는 ​​두 가지 버전의 문서를 원하지 않습니다. 특히 첫 번째 문서가 "잘못"되었을 때. 나는 어떤 꼬리표 또는 무엇인가 놓치고있는 I 'm를 추측하고있다. 그러나 나는 무엇을 이해할 수 없다.

미리 감사드립니다.

+0

두 번째 예제에서 첫 번째 도크렛을 삭제하는 이유가 용납 될 수 없습니까? 내가 떨어 뜨리면, 나에게는 괜찮아 보이는 무언가가 생긴다. – Louis

+0

@ 루이스, 해결책 인 것 같습니다. 나는 내가 따라 가려고했던 여러 가지 예들을 서로 부딪 히고 있었다고 생각한다. 감사! – JBalzer

+0

좋습니다! 나는 당신이 받아 들일 수있는 대답을 넣을 것입니다. – Louis

답변

2

두 번째 예제에서 첫 번째 도크 렛을 제거하면 문서에서 단 하나의 클래스 만 가져올 수 있으며 링크와 문서가 올바른 위치를 가리키게됩니다.

관련 문제