microsoft / microsoft/TypeScript

Hover documentation for parameters documented with jsdoc renders improperly

Abierto
#63,573 1 comentario 0 reacciones 0 asignados Ver en GitHub
Experience Enhancement Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

### 🔎 Search Terms

parameter hover documentation
jsdoc parameter hyphen
jsdoc parameter
vscode jsdoc parameter hover

### 🕗 Version & Regression Information

~~- This changed between versions ______ and _______~~
~~- This changed in commit or PR _______~~
- This is the behavior in every version I tried, and I reviewed the entire FAQ for anything that might be related to this
- I was unable to test this on prior versions because this is not a regression in typescript itself, it is a VSCode issue which I know, based on experience, will get moved to this repository.

### ⏯ Playground Link

Won't show vscode hover, so not worth pasting.

### 💻 Code

issue 1:
```ts
/**
* Foo method
* @param arg - Documentation for arg
*/
function ex1(arg: string) {
return arg;
}
```

issue 2:
```ts
/**
* Foo method
*
* @param arg Documentation for arg but it ends up being long enough that we
* must split it across lines to stay within max column width
* @param arg2 Documentation for arg but it ends up being long enough that we must split it across lines to stay within max column width
*/
function ex2(arg: string) {
return arg;
}
```

### 🙁 Actual behavior

Issue 1

The hover doc shows a bullet point when the hyphen is present (note the hover for the method itself renders properly)

Image

Issue 2

Image

### 🙂 Expected behavior

Issue 1

In example 1: The hover for `arg` should match what it does when there is no hyphen:

Image

Issue 2:

The description for arg1 should appear exactly as arg2 does.

### Additional information about the issue

Issue #61603 identified the first issue, but framed it as a bug related to not supporting TSDoc. Since jsdoc explicitly mentions the [optional hyphen](https://jsdoc.app/tags-param), this is not an issue specific to TSdoc. TypeScript support in VSCode should render this properly.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Reproduce los dos ejemplos de TypeScript/JSDoc en VS Code e inspecciona la ruta de renderizado del hover para la documentación de parámetros. Compara las descripciones con guion y con ajuste de línea; se considera terminado cuando el guion opcional no crea una viñeta no intencionada y el texto de @param ajustado se renderiza como la descripción del parámetro sin ajuste de línea.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, typescript, vscode
Área
developer-experience, tooling
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.