使用 JSDoc 记录私有构造函数

Documenting a private constructor with JSDoc

本文关键字：构造函数 记录 JSDoc 使用      更新时间：2023-09-26

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

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等）似乎无法从构建的文档中抑制它。

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

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

您应该能够使用 @ignore 指令来实现此目的。从文档中：

@ignore 标记指示代码中的符号不应出现在文档中。此标记优先于所有其他标记。

http://usejsdoc.org/tags-ignore.html

相关文章：