Microsoft/TypeScript

lib.dom.d.ts should escape html elements in jsdoc comments

Open

#44,038 创建于 2021年5月11日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)TypeScript (48,455 star) (6,726 fork)batch import
Experience EnhancementHelp WantedSuggestion

描述

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 {

贡献者指南

技术栈
typescripthtml
领域
documentationfrontend
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic TypeScript knowledgefamiliarity with JSDoc comments
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
The issue is about escaping HTML elements like `<script>` in JSDoc comments within `lib.dom.d.ts`. The fix likely involves modifying the DOM lib generator or the source files that produce these comments. Review the current JSDoc for `HTMLScriptElement` and similar interfaces, and consider using backticks or HTML entities to escape. The main challenge is understanding where the comments originate (likely in the TypeScript DOM lib generator repo). Check comments in issue #44038 for any suggested approaches.