microsoft / microsoft/TypeScript-TmLanguage

JSDoc grammar highlights @return {@link ...} as type

Offen
#877 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
471
Forks
149
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

With the following code, TS claims that {@link TreeItem} is incorrect

export interface TreeDataProvider<T> {
/**
 * @return {@link TreeItem} representation of the element
*/
 getTreeItem(element: T): TreeItem;
}

adding a character between return and {@link TreeItem} resolves it.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

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

Reproduziere die fehlerhafte Verarbeitung mit dem JSDoc-Beispiel im Issue und untersuche anschließend die TypeScript-TextMate-Grammatikregeln, die die Tags @return und inline {@link ...} abdecken. Erledigt ist die Aufgabe, wenn der Link nicht mehr als ungültiger Typ behandelt oder falsch hervorgehoben wird, während gewöhnliche @return-Typen weiterhin funktionieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
tooling
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
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.