microsoft / microsoft/TypeScript

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

Aperta
#28,514 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Domain: Comment Emit Revisit Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

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;

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Riproduci la build delle dichiarazioni da src/index.ts e src/cache/index.ts, quindi confronta l’index.d.ts generato con i commenti del codice sorgente. Traccia il percorso di emissione delle dichiarazioni per la proprietà localStorage annidata; il lavoro è completato quando il relativo commento viene preservato nel file di dichiarazioni generato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.