microsoft / microsoft/TypeScript
Show documentation for literals in intellisense
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
Suggestion
When filling in a value where the expected type is a union of literals, intellisense is able to suggest the possible values.
However, it does NOT show the documentation associated with each literal:
This makes me tend to use enums instead, which has a more verbose syntax and requires an extra import.
Use Cases
Building and documented APIs in typescript will be nicer if we could just document the literals in a union.
Search Terms
- intellisense for string literals
- documentation for string literals
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 damit, die IntelliSense-Vervollständigung für eine Vereinigung dokumentierter Zeichenfolgenliterale in TypeScript nachzubilden. Verfolge anschließend das Vervollständigungs- und Dokumentationsverhalten für Literalvorschläge und überprüfe, dass jedes vorgeschlagene Literal seine zugehörige Dokumentation anzeigt, ohne das Verhalten von enum zu ändern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- developer-experience, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100