如何使用 JSDoc3 注释 JS 模块模式类？答案

【问题标题】：How to comment a JS module pattern class using JSDoc3?如何使用 JSDoc3 注释 JS 模块模式类？
【发布时间】：2013-04-01 12:17:51
【问题描述】：

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

我做错了吗？

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

/**
 * 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() {
       //...
     }
  };
})();

【问题讨论】：

标签： javascript documentation jsdoc module-pattern

【解决方案1】：

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

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

【讨论】：