标签：javascript documentation jsdoc module-pattern

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

我做错了什么？

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

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

解决方法:

拉斐尔,我很高兴听到JSDoc 3到目前为止对你有用！

默认情况下,JSDoc省略了用@private标记的任何符号.您可以使用–private命令行选项覆盖此设置.

标签：javascript,documentation,jsdoc,module-pattern
来源： https://codeday.me/bug/20190625/1285101.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。