Use annotations to generate JSDoc comments for TS that IDEs can pick up

[jviotti]

Even things like @pattern might help here. For example:

/**
 * Represents a person in the system.
 * @description Used for user accounts and profiles.
 */
interface Person {
  /** Unique identifier (UUID v4) */
  readonly id: string;

  /**
   * Display name.
   * @example "Alice Smith"
   */
  name: string;

  /**
   * Age in years.
   * @default 18
   * @minimum 0
   */
  age?: number;

  /**
   * @deprecated Use `email` instead.
   */
  contactEmail?: string;
}

/**
 * ISO 8601 date string.
 * @pattern ^\d{4}-\d{2}-\d{2}$
 * @example "2024-01-15"
 */
type DateString = string;