microsoft / microsoft/TypeScript

Allow type parameters instead of @template tags in JSDoc

Offen
#27,512 0 Kommentare 11 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Domain: JSDoc Experience Enhancement In Discussion Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

Rather than

/**
 * @typedef Arrayify
 * @type {{ [K in keyof T]: T[K][] }}
 * @template T
 */

/**
 * @typedef Bar
 * @type {{ x: string, y: number }}
 */

/**
 * @type {Arrayify<Bar>}
 */
var x;

I hate writing out the @template tag. Can we just write it out like this?

/**
 * @typedef Arrayify<T>
 * @type {{ [K in keyof T]: T[K][] }}
 */

/**
 * @typedef Bar
 * @type {{ x: string, y: number }}
 */

 /**
  * @type {Arrayify<Bar>}
  */
var x;

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

Es werden keine Dateien, Tests oder Einstiegspunkte genannt. Beginne damit, die JSDoc-Verarbeitung für @template und @typedef zu finden, und verfolge dann, wie generische Parameter im Beispiel Arrayify dargestellt und verwendet werden. Als erledigt gilt die Aufgabe, wenn die vorgeschlagene Syntax für Typparameter ohne @template funktioniert und das bestehende JSDoc-Verhalten intakt bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
32/100

Neue Issues direkt in Ihr Postfach

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