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

JSDoc backticks not rendering correctly #3507

Open
4 tasks done
thany opened this issue Aug 24, 2022 · 1 comment
Open
4 tasks done

JSDoc backticks not rendering correctly #3507

thany opened this issue Aug 24, 2022 · 1 comment

Comments

@thany
Copy link

thany commented Aug 24, 2022

  • I have searched through existing issues
  • I have read through docs
  • I have read FAQ
  • I have tried restarting VS Code or running Vetur: Restart VLS

Info

  • Platform: Windows 10
  • Vetur version: 0.36.0
  • VS Code version: 1.70.2

Problem

JSDoc from an imported javascript file is not completely correctly displayed.

When using backticks inside the description of a @param of a plain function, they will be displayed as-is. This only happens in .vue files when importing from plain javascript files. Doing the same thing in another javascript file makes the JSDoc display correctly.

For other tags including @returns and @template this is working correctly. This problem only exists for @param.

Compare these:
image
image

Reproducible Case

  1. In your Vue project, creating a plain javascript file
  2. Add a function with JSDoc, and make sure to also add @param descriptions, as you should ;)
  3. Put any backticked word in there.
  4. Import this function in a .vue file.
  5. Try using the function, pressing Ctrl+Shift+Space if neccesary to pop up the JSDoc.
@alexander-gekov
Copy link
Contributor

Platform: Windows 11
Vetur version: 0.36.0
VS Code version: 1.71.2


I have tried putting back ticks and seems to be working on my end.
image

image

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

No branches or pull requests

3 participants