microsoft / microsoft/TypeScript
JSDoc support for destructured parameters
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
TypeScript Version: 2.0.3
Code
interface Foo {
/**
* A bar value
*/
bar?: string;
}
/**
* A function
*
* @param foo A param
* @param { bar } Another param
* @param bar Another param
*/
function foo(foo: string, { bar }: Foo): void {
bar;
foo;
}
foo('bar', { bar: 'play' });
Expected behavior:
Intellisense for the second argument, or the second argument properties.
Actual behavior:
No way of providing a description for the destructured elements of a destructured parameter.

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 TypeScript-Beispiel im Issue und reproduziere dessen IntelliSense-Verhalten mithilfe der dokumentierten JSDoc-Formen. Verfolge die Verarbeitung des Sprachdienstes für destrukturierte Parameter; als abgeschlossen gilt die Arbeit, wenn Beschreibungen für das destrukturierte Argument oder seine Eigenschaften verfügbar sind und der gemeldete Fall abgedeckt ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers, developer-experience
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100