By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement . We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use JSDoc: {@link} defines the @link , @linkplain and @linkcode tags in JavaScript and TypeScript JSDoc-style documentation comments.

As can be seen in the screenshot below the IntelliSense tooltip does not recognize the presence of the @link tag correctly.

The following describes how the different usages of @link should be rendered:

{@link https://github.com/Microsoft/vscode}
https://github.com/Microsoft/vscode

[Microsoft/vscode]{@link https://github.com/Microsoft/vscode}
Microsoft/vscode

{@link https://github.com/Microsoft/vscode|Microsoft/vscode}
Microsoft/vscode

{@link https://github.com/Microsoft/vscode Microsoft/vscode}
Microsoft/vscode

Thus the following example from Use JSDoc: {@link}#Examples

* See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}. * Also, check out {@link http://www.google.com|Google} and * {@link https://github.com GitHub}.

should render in the VS Code Intellisense tootip as:

See MyClass and MyClass's foo property . Also, check out Google and GitHub

Using the @linkplain tag instead of @link should suppress link colouring and make the link text appear as normal text.

Using the @linkcode tag instead of @link should make the link appear in a monospace font (as if the entire Link was wrapped inside an HTML <code></code> tag.

Use JSDoc: {@link} also states that the link target can be a namepath instead of a URL. Ideally, IntelliSense should suggest all known symbols in the current scope when writing the @link tag. When written, the namepath should support go-to-definition and find-all-references behaviour.

JSDoc and TypeScript IntelliSense suuport for @link inline tag JSDoc and TypeScript IntelliSense support for @link inline tag Aug 29, 2018