Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

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

VsCode wrongly parse @link block of JsDoc #48398

Closed
AnnAngela opened this issue Apr 23, 2018 · 2 comments
Closed

VsCode wrongly parse @link block of JsDoc #48398

AnnAngela opened this issue Apr 23, 2018 · 2 comments
Assignees
Labels
*duplicate Issue identified as a duplicate of another issue(s) javascript JavaScript support issues

Comments

@AnnAngela
Copy link

AnnAngela commented Apr 23, 2018

Issue Type: Bug


Steps to Reproduce:

  1. Open a .ts file;
  2. Type any code which relates to a JsDoc with @link.

In the doc of JsDoc, there are some way to create a link via @link:

{@link namepathOrURL}
[link text]{@link namepathOrURL}
{@link namepathOrURL|link text}
{@link namepathOrURL link text (after the first space)}

And there is an example:

{@link https://api.jquery.com/jQuery.cssHooks/}
[jQuery.cssHooks]{@link https://api.jquery.com/jQuery.cssHooks/}
{@link https://api.jquery.com/jQuery.cssHooks/|jQuery.cssHooks}
{@link https://api.jquery.com/jQuery.cssHooks/ jQuery.cssHooks}

But when I typed $.cssHook in a .ts file (with @types/jquery installed), the popup window, which contains the jsdoc, shows a wrong link:
image
The right brace should not be parsed as a part of the link.
Then I tried the different type of the @link:
[jQuery.cssHooks]{@link https://api.jquery.com/jQuery.cssHooks/}:
image
{@link https://api.jquery.com/jQuery.cssHooks/|jQuery.cssHooks}:
image
{@link https://api.jquery.com/jQuery.cssHooks/ jQuery.cssHooks}:
image
So is it a bug from vscode? Or misunderstanding of the rules? Can anyone help to fix it?
(Please forgive my poor English)


VS Code version: Code 1.22.2 (3aeede7, 2018-04-12T16:38:45.278Z)
OS version: Windows_NT x64 10.0.17133

System Info
Item Value
CPUs Intel(R) Core(TM) i7-6500U CPU @ 2.50GHz (4 x 2592)
Memory (System) 7.90GB (2.86GB free)
Process Argv C:\Program Files\Microsoft VS Code\Code.exe D:\Ann\FFXIV4.0Script
Screen Reader no
VM 0%
Extensions (4)
Extension Author (truncated) Version
html-snippets abu 0.2.1
vscode-eslint dba 1.4.8
tslint eg2 1.0.28
vetur oct 0.11.7
@vscodebot
Copy link

vscodebot bot commented Apr 23, 2018

(Experimental duplicate detection)
Thanks for submitting this issue. Please also check if it is already covered by an existing one, like:

@vscodebot vscodebot bot added the javascript JavaScript support issues label Apr 23, 2018
@mjbvz
Copy link
Collaborator

mjbvz commented Apr 23, 2018

Duplicate of microsoft/TypeScript#16498

@mjbvz mjbvz marked this as a duplicate of microsoft/TypeScript#16498 Apr 23, 2018
@mjbvz mjbvz closed this as completed Apr 23, 2018
@mjbvz mjbvz added the *duplicate Issue identified as a duplicate of another issue(s) label Apr 23, 2018
@vscodebot vscodebot bot locked and limited conversation to collaborators Jun 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*duplicate Issue identified as a duplicate of another issue(s) javascript JavaScript support issues
Projects
None yet
Development

No branches or pull requests

2 participants