Microsoft/TypeScript

`@` character in code block renders poorly in tooltip

Open

#49 273 ouverte le 26 mai 2022

Voir sur GitHub
 (7 commentaires) (10 réactions) (0 assignés)TypeScript (6 726 forks)batch import
BugDomain: JSDocHelp Wanted

Métriques du dépôt

Stars
 (48 455 stars)
Métriques de merge PR
 (Merge moyen 6j 17h) (9 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le bug apparaît dans le rendu de l'infobulle des types TypeScript lorsqu'un bloc de code contient le caractère '@'. Examinez le code de rendu de l'infobulle/survol dans le service de langage TypeScript, probablement dans src/services/hover.ts ou des fichiers associés. Le problème comporte plusieurs commentaires qui peuvent fournir des indices. La correction implique probablement un échappement ou une gestion appropriée du caractère '@' dans les blocs de code markdown.
Stack technique
typescript
Domaine
frontend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitTypeScript basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65