microsoft / microsoft/TypeScript

Documentation: Clarify declaration files and the declare keyword

Aperta
#23,262 2 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Docs
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

TypeScript Version: 2.8.0

Search Terms:
document declaration files

** Issue**
It doesn't look like you actually define what a declaration file is in your documentation. For instance, your introduction to these at https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html tells me you're going to help me learn how to write them, but not what they are or why I'd want one. But, I don't think this makes it easy for a newbie to understand.

Similarly, you don't seem to explain when the declare keyword is, or when it should be used (as far as I can tell, it is used when you need to tell the compiler that the module/library/whatever has a value of some type).

You also seem to make some references to the global namespace (declare global { ... })), but don't seem to directly explain it anywhere.

Code
n/a

Expected behavior:
n/a

Actual behavior:
n/a

Playground Link:
n/a

Related Issues:
n/a

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

Inizia con l’introduzione ai declaration files all’indirizzo https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html, quindi segui i relativi riferimenti a declare global e alle indicazioni correlate sui declaration files. Esamina il materiale circostante dell’handbook prima di apportare modifiche. Il lavoro è completato quando la documentazione definisce chiaramente i declaration files, spiega perché e quando usare declare e spiega direttamente il namespace globale.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.