TSLint Закончено Правило Документов - Не Проверять Суперкласс? - PullRequest
Новая
       23

TSLint Закончено Правило Документов - Не Проверять Суперкласс?

0 голосов
/ 01 февраля 2020

У меня есть структура интерфейса / суперкласса / подкласса, благодаря которой подкласс действительно существует только для определения определенных c типов и обеспечения некоторой дополнительной проверки типов во время компиляции. В машинописном тексте комментарии jsdo c объединяются - поэтому, если комментарий определен для родителя (например, интерфейса), он автоматически будет проходить через реализующие классы.

Это отлично работает в Visual Студийный код с intellisense - это правильно обнаружение комментария к документации интерфейса. И до сих пор с этим правилом completed-docs было просто замечательно.

Однако недавно я обновил свой проект до Angular 8, и это произошло с обновлением до Typescript и tslint. правила и др. c. - теперь это правило жалуется на все места, где документация определяется в суперклассе, а не в подклассе. Если не считать правила, есть ли способ настроить / отключить это поведение?

Пример: 

export interface MyInterface {
  /** This is an example documentation comment. */
  myProperty: string;
}

export class MyClass implements MyInterface {
  myProperty: MyStringEnumType;  // this should not need a documentation comment
                                 // but completed-docs rule is failing it anyway. why?
}

enum MyStringEnumType {
  value1 = 'value1'
}

Текущая конфигурация правила: 

/* JSDoc comments required */
"completed-docs": [
  true,
  {
    "enums": true,
    "functions": {"visibilities": ["exported"]},
    "interfaces": true,
    "methods": {"locations": "all", "privacies": ["protected", "public"]},
    "properties": {
      "privacies": ["public", "protected"], "tags": {"content": {"see": ["#.*"]}, "existence": ["inheritdoc"]}
    }
  }
],
...