microsoft / microsoft/TypeScript

Hover documentation for parameters documented with jsdoc renders improperly

Aperta
#63,573 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Experience Enhancement Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

### 🔎 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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Riproduci i due esempi TypeScript/JSDoc in VS Code e ispeziona il percorso di rendering dell'hover per la documentazione dei parametri. Confronta le descrizioni con trattino e con ritorno a capo; il lavoro è completato quando il trattino opzionale non crea un elenco puntato indesiderato e il testo @param con ritorno a capo viene renderizzato come la descrizione del parametro senza ritorno a capo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, typescript, vscode
Ambito
developer-experience, tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.