JS Doc @Link support for referring to property of class/interface

[mjbvz]

Bug Report

🔎 Search Terms

• jsdoc
• @link
• @see

🕗 Version & Regression Information

4.3.0-dev.20210325

💻 Code

For the TS:

interface Foo {
    /**
     * {@link Foo#xyz}
     * 
     * {@link Foo.xyz}
     * 
     * {@link Foo~xyz}
     * 
     * {@link xyz}
     */
    abc: number;
    
    /**
     * {@link abc}
     */
    xyz: number;
}

Hover over abc and view the links.

🙁 Actual behavior

None of the links are resolved. I was not able to find a way to have documentation on one property refer to another property

🙂 Expected behavior

If we are following JSDoc, I'd expect that Foo#xyz would be resolved. However we may also want to support: xyz (and maybe Foo.xyz?)

[sandersn]

Initial @link support parses entity names (dotted names) but does not resolve them.
Edit: it does actually resolve them, but not the Typescript syntax for referring to class members, Foo.prototype.xyz.

Filed #43594 to track parsing #.
Filed #43595 to track within-class/interface lookup.

I'll look at the first two after the 4.3 release.

[mjbvz]

@sandersn Are there any workarounds for this issue planned for TS 4.3? We're eager to start adopting@link in our d.ts (microsoft/vscode#120120) but not being able to link to properties is a pretty significant limitation

[sandersn]

I can look at it during the beta if it's blocking your adoption. I can probably put some special-case code in the services-only symbol lookup.

[Stan-Stani]

Not sure if I should mention this in VSCode or here, but I seem to get intermittent errors with this syntax.

But VSCode seems to display the actual rendered doc comment fine: