4

这就是我实际执行此操作的方式,但是在生成文档后私有方法和属性不可见。

我做错了什么吗?

顺便说一句,其他一切都很好。我第一次使用文档生成器,印象非常深刻。

/**
 * 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

1 回答 1

4

Raphael,我很高兴听到 JSDoc 3 到目前为止对你很有效!

默认情况下,JSDoc 会省略任何带有@private. 您可以使用--private命令行选项覆盖此设置。

于 2013-04-02T14:18:23.960 回答