添加链接
link管理
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接
相关文章推荐
沉稳的石榴  ·  TypeScript: TSConfig ...·  2 周前    · 
忧郁的薯片  ·  no-unused-vars | ...·  2 周前    · 
深沉的卡布奇诺  ·  TypeScript: ...·  1 周前    · 
爱旅游的打火机  ·  TypeScript 오류 ...·  昨天    · 
苦闷的饺子  ·  How to Query a JSON ...·  7 月前    · 
另类的砖头  ·  GroupBy 和 Ungroup 函式 ...·  9 月前    · 
骑白马的沙滩裤  ·  ps ...·  10 月前    · 

JSDoc and TypeScript IntelliSense support for @link inline tag #57495

Closed

Description

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.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Assignees

    Labels

    *duplicate Issue identified as a duplicate of another issue(s) javascript JavaScript support issues upstream Issue identified as 'upstream' component related (exists outside of VS Code)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions