microsoft / microsoft/TypeScript

Export a object with comment ,but the comment is missing after build a *.d.ts file

Offen
#28,514 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Domain: Comment Emit Revisit Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

I export an object,then I build to a declare file like index.d.ts,but the file has no comment about that object.

Source code
//src/cache/index.ts
import * as  localStorage from "./localStorage"
export default {
    /**
     * This is a comment2
     */
    localStorage
}

//src/index.ts
import cache from "./cache/index"
export default {
    /**
     * This is a comment1
     */
    cache
}
Index.d.ts
declare const _default: {
    /**
     * This is a comment1
     */
    cache: {
        localStorage: typeof import("./cache/localStorage");//#### This field's comment is missing ####
    };
};
export default _default;

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 den Deklarations-Build aus src/index.ts und src/cache/index.ts und vergleiche die generierte index.d.ts mit den Quellkommentaren. Verfolge den Pfad zur Deklarationsausgabe für die verschachtelte localStorage-Eigenschaft; abgeschlossen ist die Aufgabe, wenn ihr Kommentar in der generierten Deklarationsdatei erhalten bleibt.

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
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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