microsoft / microsoft/TypeScript

JSDoc tooltip for function type

Offen
#44,469 0 Kommentare 0 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

Suggestion

🔍 Search Terms

JSDoc tooltip for function type

✅ Viability Checklist

My suggestion meets these guidelines: Yes.

⭐ Suggestion

Show JSDoc tooltip for function type.

📃 Motivating Example

interface F {
  /**
   * Documentation.
   */
  (): void;
}

const f: F;

// In Visual Studio Code I see JSDoc tooltip on mouse hover when I use interface.
f();

/**
 * Documentation.
 */
type G = () => void;

const g: G;

// No JSDoc tooltip for function type.
g();

💻 Use Cases

This should improve working experience when using editors like Visual Studio Code.

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, die für die Interface-Call-Signatur und den im motivierenden Beispiel gezeigten Funktionstypalias verwendeten TypeScript-Sprachdienst-Hoverinformationen nachzuverfolgen. Reproduziere beide Fälle in Visual Studio Code und vergleiche die zurückgegebenen Tooltips; erledigt ist dies, wenn der Funktionstyp seinen JSDoc-Tooltip wie angefordert erhält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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