如何避免jsDoc中的构造函数文档?

问题描述 投票:0回答:0

我有一个只声明静态方法的类,如

class Foo {

  /**
  * This method does nothing
  */
  static doNothing() {
  }
}

但是,

jsDoc
还为类的未声明构造函数生成文档,因此,从文档来看,类似乎能够生成实例,这不是它打算做的。

如果我声明构造函数明确告诉

jsDoc
忽略它,如

class Foo {

  /**
  * @ignore
  */
  constructor() {
  }

  /**
  * This method does nothing
  */
  static doNothing() {
  }
}

jsDoc 忽略了整个类。

也许,一个只有静态方法的类不应该被认为是一个类。 这对我来说很有意义,因此,我正在重新考虑我的图书馆的设计。 但是,我很想知道是否有人遇到过这样的问题以及他是如何解决的。

javascript jsdoc
© www.soinside.com 2019 - 2024. All rights reserved.