microsoft / microsoft/TypeScript
Syntax highlighting can not resolve @throws of tsdoc
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
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: https://github.com/microsoft/vscode/issues/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% |
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Reproduziere das Problem mit dem TSDoc-Beispiel, das @throws {@link IsbnSyntaxError} in VS Code 1.89.1 verwendet. Prüfe zunächst, ob Syntaxhervorhebung im TypeScript-TmLanguage-Projekt implementiert ist, wie der Bericht nahelegt, und vergleiche mit Issue #135417. Erledigt ist die Aufgabe, wenn das Tag als Link oder zumindest als ununterbrochener Klartext dargestellt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript, vscode
- Bereich
- developer-experience, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 28/100