Visual Studio Code - Finns det ett sätt att dokumentera fält i ett interface i TypeScript?

Säg att jag har följande:

interface Validator {
  validate: (value: string) => boolean;
  errorMessage: string;
}

interface EditDialogField {
  label: string;
  prop: string;
  required?: boolean;
  type: 'input';
  validators?: Validator[];
}

Detta är användbart, eftersom IntelliSense visar förslag när jag använder dessa gränssnitt, men jag skulle vilja ha möjligheten att lägga till kommentarer som också syns i IntelliSense (specifikt VS Code). Är detta möjligt?

Svar #1

Förstått!

interface EditDialogField {
  /** Explain label here */
  label: string;
  /** Explain prop here */
  prop: string;
  required?: boolean;
  type: 'input';
  validators?: Validator[];
}

Svar #2

Om du vill se det visas när din mus hovrar i din editor, föreslår jag att du dokumenterar gränssnittet och använder @field inuti dokumentationskommentaren.

Alternativt kan du använda @member, kanske det ger en bättre syntaxmarkering för dokumentationen

/**
 * This is the description of the interface
 *
 * @interface EditDialogField
 * @member {string} label is used for whatever reason
 * @field {string} prop is used for other reason
 */
interface EditDialogField {
  label: string;
  prop: string;
  required?: boolean;
  type: 'input';
  validators?: Validator[];
}

Resultat inom VSCode

Relaterade artiklar