@see for property ref in __type__ reference

Suggestion

🔍 Search Terms

jsdoc tsdoc @see @link docs types

✅ Viability Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

📃 Motivating Example

export type A = {
  /**
   * The import ID from which the re-export was imported from.
   */
  foo: string
}

export namespace A {
  export type Params = {
    /**
     * @see {@link A['foo']}
     */
    foo: string
  }
  
  export const create = (params:Params): A => {
      return 'todo' as any
  }
}

Here is the above code (approx) in an interactive VSC setting, note the following:

1. Want to navigate to type alias but it goes to namespace
2. Want to point at a specific property, cannot

I do not have a concrete suggestion yet about how to achieve this.

First want to validate the problem with others.

💻 Use Cases

Want to share the JSDoc between a property on a constructor and a data type.

Riproduci l’esempio motivante in VS Code e confronta il modo in cui il riferimento JSDoc @see/@link a A['foo'] viene risolto rispetto al namespace. Inizia validando il comportamento di navigazione segnalato e determinando una sintassi o una regola di risoluzione concreta; il lavoro sarà completato quando sarà stato concordato un approccio per puntare alla proprietà specifica e condividerne la documentazione.