2013-12-18 3 views
0

Я использую команду 1для создания набора компонентов, и я использую JsDoc для создания документации для них. Когда я создаю «класс», как это:JsDoc удваивает мои классы

/** 
* Tests a thing to see what it is, baby 
* @param {string=}Id the Id babyyyy 
* @constructor 
*/ 
TestThing = function(Id){ 
    /** 
    * The thing's id 
    * @type {string=} 
    */ 
    this.Id = Id; 
} 

/** 
* Gets the thing 
* @param {number} id 
* @returns {number} 
* @memberof TestThing 
*/ 
TestThing.prototype.Get = function(id){ 
    return 5; 
} 

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 
    } 
}) 

я документацию с 2-х версиях класса на той же странице, первый без аргументов конструктора (так новый TestThing2()) и второй с аргументами (новый TestThing2 (id)).

Очевидно, что мне не нужны две версии документации, особенно если первая является «неправильной». Я предполагаю, что мне не хватает какого-то тега или чего-то еще, но я не могу понять, что.

Заранее спасибо.

+0

Есть ли какая-нибудь причина, отбрасывающая первый документ в вашем втором примере, была бы неприемлема? Если я его брошу, я получу то, что мне кажется. – Louis

+0

@ Луис, это, кажется, решение. Наверное, я скрещивал разные примеры, которые я пытался придерживаться. Благодаря! – JBalzer

+0

Отлично! Я поставлю ответ, который вы можете принять. – Louis

ответ

2

Если вы удалите первый документ в своем втором примере, вы получите только один класс в документации, со ссылками и документами, указывающими на нужное место.

Смежные вопросы