2013-04-01 5 views
4

Так я и делаю это, но частные методы и свойства не видны после создания Документации.Как прокомментировать класс шаблона модуля JS с помощью JSDoc3?

Я сделал что-то не так?

Кстати, все остальное отлично работает. Я использую первый генератор документации, и я очень впечатлен.

/** 
* Constructor Description 
* @constructor 
* @class 
* @classdesc Something about my class Foo. 
*/ 
container.Foo = function() { this.init(); }; 
container.Foo.prototype = (function() { 

    /** 
    * @private 
    * @name container.Foo~fooPropertyPrivat 
    * @property {boolean} fooPropertyPrivat Some description 
    */ 
    var fooPropertyPrivat = true; 

    /** 
    * Some description 
    * @private 
    * @name container.Foo~doSomethingPrivat 
    * @memberOf container.Foo 
    * @method doSomethingPrivat 
    */ 
    function doSomethingPrivat() { 
     //... 
    } 

    return { 
    /** 
    * @public 
    * @name container.Foo#fooPropertyPublic 
    * @property {boolean} fooPropertyPublic Some description 
    */ 
    fooPropertyPublic: true, 

    /** 
    * Some description 
    * @public 
    * @constructs 
    * @name container.Foo#init 
    * @memberOf container.Foo 
    * @method init 
    */ 
    init: function() { 
     //... 
    } 
    }; 
})(); 

ответ

4

Рафаэль, я рад слышать, что JSDoc 3 работает для вас до сих пор!

По умолчанию JSDoc пропускает любой символ, помеченный @private. Вы можете переопределить этот параметр, используя опцию командной строки --private.

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

  • Нет связанных вопросов^_^