Использование избыточного JSdoc в докблоках TypeScript. Это нужно? - PullRequest
0 голосов
/ 28 июня 2019
export class FooClass {

  constructor() { }

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

Итак, мне интересно, полезно ли добавлять @memberOf Class документацию в TypeScript.

Поиск в Google Я нашел это как первый результат: https://usejsdoc.org/tags-memberof.html. Проблема в том, что этот сайт возвращает ошибку Server Not Found, и документация, которую я нашел до сих пор, очень устарела.

По моему скромному мнению, использование @memberOf добавляет только шум в кодовую базу. Я не прав?

1 Ответ

1 голос
/ 28 июня 2019

Я бы согласился, что простое использование TypeScript делает несколько (многие? Большинство?) Тегов JSDoc избыточными и определенно в приведенном вами примере.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...