在TypeScript文档块中使用冗余JSdoc。需要吗?

时间:2019-06-28 14:09:27

标签: typescript jsdoc

export class FooClass {

  constructor() { }

  /**
   * A description
   *
   * @memberOf FooClass
   */
  barMethod(): Observable<Baz[]> {
    return this.http.get<Baz[]>(this.infoService.apiURL + '/bazs');
  }
}

因此,我想知道在TypeScript中添加@memberOf Class文档是否有用。

在Google上进行搜索,我发现这是第一个结果:https://usejsdoc.org/tags-memberof.html。问题在于该网站返回了Server Not Found错误,而到目前为止我发现的文档已经过时了。

在我看来,使用@memberOf只会在代码库中增加噪音。我错了吗?

1 个答案:

答案 0 :(得分:1)

我同意,仅使用TypeScript会使多个(很多?大多数?)JSDoc标签变得多余,而且肯定在您提供的示例中。