有没有办法在TypeScript中记录接口中的字段？

Question

说我有以下内容：

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

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

这很有用，因为当我使用这些界面时，IntelliSense会弹出建议，但我希望能够添加也显示在IntelliSense（特别是VS Code）中的注释。这可能吗？

Answer 1

如果您想在编辑器中将鼠标悬停时看到它出现，建议您记录该界面并在文档注释中使用@field。

或者，您可以使用@member，也许可以为文档提供更好的语法突出显示

/**
 * 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[];
}

VSCode内部的结果

Answer 2

知道了！

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