Microsoft/TypeScript
lib.dom.d.ts should escape html elements in jsdoc comments
开放
#44,038 创建于 2021年5月11日
Experience EnhancementHelp WantedSuggestion
仓库指标
- 星标
- (108,860 个星标)
- PR 合并指标
- (PR 指标待抓取)
描述
lib Update Request
Configuration Check
My compilation target is ES2020 and my lib is the default.
Missing / Incorrect Definition
For html elements such as HTMLScriptElement, the JSDoc includes <script>. This causes VS Code to drop the entire body of the comment
Sample Code
const a: HTMLScriptElement // hover over HTMLScriptElement
Proposal
These JSDoc comments should escape any html in the comments. I suggest using markdown inline code instead:
/** HTML `<script>` elements expose the HTMLScriptElement interface ... */
interface HTMLScriptElement extends HTMLElement {