microsoft / microsoft/TypeScript
wiki doc: @template reference re: jsdoc (and old usejsdoc.org reference)
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
TypeScript Version: N/A
Search Terms: docs, template, wiki
Code
N/A
Expected behavior:
@template is not a recognized tag per https://jsdoc.app/ , even if could be compatible as a custom tag. I think your docs at https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript should make clear that while the other items in the list of jsdoc tags are standard jsdoc, the particular tag @template is an exception and is not standard jsdoc.
Also, the reference to "usejsdoc.org" should be changed to its new site: jsdoc.app. (See https://github.com/jsdoc/jsdoc/issues/1642 on the lack of a working redirect.)
Actual behavior:
- https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript seems to imply that
@templateis a valid, standard jsdoc tag or at least doesn't clarify that it is a custom tag and not one with behaviors compatible with jsdoc. - The docs link to usejsdoc.org
Playground Link:
N/A
Related Issues:
None found.
@sandersn
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Apri la pagina wiki di TypeScript “JSDoc support in JavaScript” e confronta la descrizione di @template con i tag standard elencati su jsdoc.app. Chiarisci che @template non è un tag JSDoc standard e sostituisci il riferimento obsoleto a usejsdoc.org con jsdoc.app; la pagina wiki deve contenere entrambe le correzioni.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 1/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 35/100