Microsoft/TypeScript

wiki doc: @template reference re: jsdoc (and old usejsdoc.org reference)

Open

#31,885 建立於 2019年6月13日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)TypeScript (48,455 star) (6,726 fork)batch import
DocsHelp Wanted

描述

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:

  1. https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript seems to imply that @template is 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.
  2. The docs link to usejsdoc.org

Playground Link:

N/A

Related Issues:

None found.

@sandersn

貢獻者指南

技術棧
typescriptjavascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
familiarity with TypeScript wiki's JSDoc support page
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
95
研究方向
The issue requests two changes to the TypeScript wiki page 'JSDoc support in JavaScript' (https://github.com/Microsoft/TypeScript/wiki/JSDoc support in JavaScript): (1) Add a note clarifying that @template is a custom TypeScript tag, not a standard JSDoc tag. (2) Update the link from usejsdoc.org to jsdoc.app, as the former no longer redirects. The fix involves editing the wiki page directly; the repository for the wiki is likely a separate git repo (TypeScript.wiki.git) or can be edited via GitHub's wiki interface. The maintainer @sandersn was tagged in the issue. No linked PRs or additional comments indicate ongoing work.