Microsoft/TypeScript

`@` character in code block renders poorly in tooltip

Open

#49.273 aberto em 26 de mai. de 2022

Ver no GitHub
 (7 comments) (10 reactions) (0 assignees)TypeScript (6.726 forks)batch import
BugDomain: JSDocHelp Wanted

Métricas do repositório

Stars
 (48.455 stars)
Métricas de merge de PR
 (Mesclagem média 6d 17h) (9 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
O bug aparece na renderização da dica de ferramenta (tooltip) dos tipos TypeScript quando um bloco de código contém o caractere '@'. Investigue o código de renderização de dica de ferramenta/hover no serviço de linguagem do TypeScript, provavelmente em src/services/hover.ts ou arquivos relacionados. O problema tem vários comentários que podem fornecer pistas. A correção provavelmente envolve o escape ou tratamento adequado do caractere '@' em blocos de código markdown.
Pilha de tecnologia
typescript
Domain
frontend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitTypeScript basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65