Microsoft/TypeScript
wiki doc: @template reference re: jsdoc (and old usejsdoc.org reference)
Aperta
#31.885 aperta il 13 giu 2019
DocsHelp Wanted
Metriche repository
- Star
- (108.860 stelle)
- Metriche merge PR
- (Metriche PR in attesa)
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