microsoft / microsoft/TypeScript
Hover documentation for parameters documented with jsdoc renders improperly
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
### 🔎 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)
Issue 2
### 🙂 Expected behavior
Issue 1
In example 1: The hover for `arg` should match what it does when there is no hyphen:
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.
Beitragsleitfaden
Rechercherichtung
Reproduziere die beiden TypeScript/JSDoc-Beispiele in VS Code und untersuche den Hover-Rendering-Pfad für die Parameterdokumentation. Vergleiche Beschreibungen mit Bindestrich und mit Zeilenumbruch; abgeschlossen ist die Aufgabe, wenn der optionale Bindestrich keinen unbeabsichtigten Aufzählungspunkt erzeugt und umgebrochener @param-Text wie die nicht umgebrochene Parameterbeschreibung gerendert wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript, vscode
- Bereich
- developer-experience, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100