microsoft / microsoft/TypeScript
support destructuring parameter @param tag in tsdoc
Offen
Dieses Issue hat noch niemand übernommen.
Experience Enhancement
Suggestion
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
tsdoc rule:
https://github.com/microsoft/tsdoc/issues/186
vscode issue:
https://github.com/microsoft/vscode/issues/80368
example:
/**
*
* @param bar - the bar parameter
* @param a - the first parameter
* @param b - the second parameter
* @param c - the third parameter
* @returns the return value
*/
function foo(bar: string, {
a,
b,
c
}:{
a: string,
b: number,
c: string
}) {
return bar + a;
}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Destructuring-Beispiel und prüfe die verknüpften TSDoc- und VS Code-Issues, um das erwartete @param-Verhalten zu verstehen. Finde die TypeScript-Dokumentation oder die Behandlung im language-service für destrukturierte Parameter und füge anschließend Abdeckung hinzu, die zeigt, dass a, b und c die vorgesehene Parameterdokumentation erhalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- developer-experience, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100