microsoft / microsoft/TypeScript

Intellisense should inherit documentation for Interfaces.

Offen
#29,516 4 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Experience Enhancement Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

When implementing an interface the intellisense feature is capable of detecting the description of the interface however it does not carry over any tags such as @param and @returns.

Below is a picture of an example:

image

You can see that the description is properly shown however the param and returns tag is not.
What is expected:

image

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das gemeldete IntelliSense-Verhalten mit einer Schnittstelle zu reproduzieren, die Dokumentation und @param/@returns-Tags enthält, und untersuche anschließend den TypeScript-Sprachdienstpfad, der die Dokumentation für implementierte Schnittstellenmitglieder bereitstellt. Die Aufgabe ist abgeschlossen, wenn das implementierende Mitglied die Schnittstellenbeschreibung zusammen mit den geerbten Parameter- und Rückgabe-Tags anzeigt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
developer-experience
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.