Как добавить описание для ввода ключей / констант с помощью typcript / jsdoc? - PullRequest
0 голосов
/ 20 сентября 2019

У меня есть определение типа, которое выглядит так:

export type Directions = 'UP' | 'DOWN' | 'LEFT' | 'RIGHT';
export type LookAt = {
  direction: Directions;
};

И автозаполнение выглядит так:
enter image description here

Но я хочуЧтобы добавить описание к каждому свойству:

export type Directions =
  /**
   * By looking up the item will be automatically attached to the top
   */
  | 'UP'
  /**
   * By looking down the item will be automatically attached to the bottom
   */
  | 'DOWN'
  /**
   * By looking left the item will be automatically attached to the left
   */
  | 'LEFT'
  /**
   * By looking right the item will be automatically attached to the right
   */
  | 'RIGHT';

Но при автозаполнении не отображается описание элемента, только имя свойства

enter image description here

Как добавить описание ситуации такого рода?

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