microsoft / microsoft/TypeScript

JSDoc type reference doesn't skip leading asterisk

Offen
#32,280 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bug Domain: JSDoc
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

TypeScript Version: typescript@3.6.0-dev.20190704

Search Terms:
checkjs
jsdoc
multi-line
multiline
Code

/**
 * @returns {
 *   | 'a'
 *   | 'b'
 *   | 'c'
 * } - this type is parsed as `any`.
 */
function f() {
  return true;
}

Expected behavior:
Error on incompatible return type.
Actual behavior:
No error. The jsdoc return type is parsed as any.
Playground Link:
Not available.

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

Reproduziere das Problem mit dem mehrzeiligen JSDoc-@returns-Beispiel im Bericht und untersuche den TypeScript-JSDoc-Typanalysepfad. Überprüfe, dass führende Sternchen übersprungen werden und dass die inkompatible boolesche Rückgabe einen Fehler erzeugt, anstatt den Typ als any zu behandeln.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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