javascript - 使用 JSDoc 记录私有(private)构造函数

Question

我有一个类，其中可以静态调用各个方法，但会返回一个类的新实例以便链接，例如:

var builder = ns
  .setState('a', 'A')
  .setState('b', 'B');

Builder 定义如下:

/** 
 * @module Builder 
 */

/**
 * @class Builder 
 */

/**
 * @private
 */
function Builder() {
  this.state = {
    query: {}
  };
}
Builder.prototype = {
  /**
   * @param {string} k - The key
   * @param {object} v - The value
   * @return {Builder}
   */
  setState: function(k, v) {
    var that = (this instanceof Builder) ? this : new Builder();
    that[k] = v;
    return that;
  }
  // Other properties and methods…
}

Builder 构造函数从不 应该由用户代码显式调用，因此我不希望它出现在文档中。但是，我尝试使用 JSDoc 标签(例如 @private、@constructs 等)的所有组合似乎都无法从构建的文档中抑制它。

Answer 1

从jsDoc 3.5.0版本开始，可以使用标签@hideconstructor在类上，告诉 jsDoc 不要将构造函数包含到文档中。

/**
 * @class Builder
 *
 * @hideconstructor
 */
function Builder() {
    // implementation
}