Repository navigation
Syntax highlighting can not resolve @throws of tsdoc #58599
Description
Type: Bug
Syntax highlighting for typescript has problem for the function that has @throws .
TSDoc used @throws {@link IsbnSyntaxError} format but VSCode shows broken lint text with break-lines like below:
// from tsdoc sample: https://tsdoc.org/pages/tags/throws/
type Book = any;
/**
* @throws {@link IsbnSyntaxError}
* This exception is thrown if the input is not a valid ISBN number.
*/
function fetchBookByIsbn(isbnCode: string): Book {}I thought vscode does not support tsdoc and using jsdoc but jsdoc does not shows correct info too. (this may be related with: microsoft/vscode#135417 )
I expected it shows a link for the Type, at least shows as simple text without break-line.
I may have to report this on other project (TmLanguage? https://github.com/microsoft/TypeScript-TmLanguage/issues) but I did here from VSCode reporter anyway.
VS Code version: Code 1.89.1 (dc96b837cf6bb4af9cd736aa3af08cf8279f7685, 2024-05-07T05:13:33.891Z)
OS version: Windows_NT x64 10.0.19045
Modes:
System Info
| Item | Value |
|---|---|
| CPUs | Intel(R) Core(TM) i5-8500 CPU @ 3.00GHz (6 x 3000) |
| GPU Status | 2d_canvas: enabled canvas_oop_rasterization: enabled_on direct_rendering_display_compositor: disabled_off_ok gpu_compositing: enabled multiple_raster_threads: enabled_on opengl: enabled_on rasterization: enabled raw_draw: disabled_off_ok skia_graphite: disabled_off video_decode: enabled video_encode: enabled vulkan: disabled_off webgl: enabled webgl2: enabled webgpu: enabled |
| Load (avg) | undefined |
| Memory (System) | 31.78GB (11.72GB free) |
| Process Argv | --disable-extensions --crash-reporter-id ca2a1b94-1896-42fa-87dc-e58738a43fa3 |
| Screen Reader | no |
| VM | 0% |
Activity
[-]Syntax highlighting can not show @throws of tsdoc[/-][+]Syntax highlighting can not resolve @throws of tsdoc[/+]nabe1653 commentedon May 21, 2024
I used vscode's report feature but now I noticed issued on typescript repo.
VSCode created this ticket automatically without my chooing (I didn't select typescript name).
If this should be reported on vscode repo, so sorry, I will close this and copy this there.
MartinJohns commentedon May 21, 2024
The issue was transferred to the TypeScript repo by mjbvz.
According to #49891 this should work if you drop the
@link.nabe1653 commentedon May 22, 2024
Thank you for your replying and sorry about taking your time.
I don't know about correct English word so used syntax-highlighting name but I'd like to say about the link in hover-info.
I tried to drop
@linkthen I got below situation:{@link Class}that in description part has a link on both code and hover-info.In my understanding, vscode has a link on both. I expected this working for type part too.
[JSDoc]
@throws {Class}has a link on code but not in hover.[TSDoc]
@throws {@link Class}does not have a link on both and hover has broken text.(above
{@link IsbnSyntaxError}is green color like 2nd too but does not have a link)Therefore I wished 2 points:
I wished hover-info has correct link to read ErrorClass info at the function is called as same as
@linkon description part.And I can use jsdoc format but I wish to support tsdoc style too for ts code if possible.