microsoft / microsoft/TypeScript

Support JSDoc `@function`

Offen
#14,275 2 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Committed Domain: JSDoc Suggestion VS Code Tracked
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

From: https://github.com/Microsoft/vscode/issues/21321

TypeScript Version: 2.2.1 / nightly (2.2.0-dev.201xxxxx)

Code

// test-module.d.ts
declare module 'test-module' {
    declare function func<T>(c: T): (y: any) => any;
}
// example.js
import { func } from 'test-module';

/** 
 * @function
 * @param {number} c first number
 * @returns {number} result
 */
const thisDoesNot = func(1);

Expected behavior:
The JSDoc specifications give thisDoesNot a type of (c: number) => number

Actual behavior:
The type from the *.d.ts file is preferred instead, giving thisDoesNot a type of (c: any) => any

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 den gezeigten test-module.d.ts- und example.js-Snippets und verfolge anschließend TypeScripts Verarbeitung von JSDoc @function sowie die Auswahl importierter Deklarationstypen. Die Aufgabe ist abgeschlossen, wenn die JSDoc-Annotationen für thisDoesNot (c: number) => number erzeugen, ohne die normale Typisierung von Deklarationsdateien zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 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.