Microsoft/TypeScript

`@` character in code block renders poorly in tooltip

Open

#49.273 geöffnet am 26. Mai 2022

Auf GitHub ansehen
 (7 Kommentare) (10 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import
BugDomain: JSDocHelp Wanted

Repository-Metriken

Stars
 (48.455 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (9 gemergte PRs in 30 T)

Beschreibung

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version: 1.67.2 (Universal)
  • OS Version: Darwin arm64 21.4.0

Steps to Reproduce:

When having this chunk of source code:

/**
 * Description of CursorClass
 *
 * Example Usage:
 * 
 * ````ts
 * @IsCursor(CursorClass)
 * cursor?: CursorClass | null;
 * ````
 */

VSCode renders as this: image

It should render as this: image

Contributor Guide

Research-Richtung
Der Fehler tritt beim Rendern der Tooltip Anzeige von TypeScript Typen auf, wenn ein Codeblock das '@' Zeichen enthält. Untersuchen Sie den Hover/Tooltip Rendering Code im TypeScript Sprachdienst, wahrscheinlich in src/services/hover.ts oder verwandten Dateien. Das Problem hat mehrere Kommentare, die Hinweise geben können. Die Lösung beinhaltet wahrscheinlich eine korrekte Maskierung oder Handhabung des '@' Zeichens in Markdown Codeblöcken.
Tech Stack
typescript
Domain
frontend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitTypeScript basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65