microsoft / microsoft/TypeScript
Support @param tag on function type
Offen
Dieses Issue hat noch niemand übernommen.
Domain: JSDoc
Domain: LS: Quick Info
Domain: LS: Signature Help
In Discussion
Suggestion
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Examples
/**
* @param a A doc
* @param b B doc
*/
type F = (a: number, b: number) => number;
Hover over a or b -- I would expect to see parameter documentation.
It would also be nice to get it at a in const f: F = (a, b) => a + b;.
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
Es wird keine Datei, kein Test und kein Einstiegspunkt genannt. Reproduziere die beiden Hover-Beispiele aus dem Issue und untersuche die bestehende Verarbeitung der @param-Dokumentation; als abgeschlossen gilt die Aufgabe, wenn die Parameterdokumentation beim Hover über die Parameter eines Funktionstyps und über Parameter in einem Wert angezeigt wird, der mit diesem Funktionstyp typisiert ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100