Microsoft/TypeScript
GitHub で見るlib.dom.d.ts should escape html elements in jsdoc comments
Open
#44,038 opened on 2021年5月11日
Experience EnhancementHelp WantedSuggestion
Repository metrics
- Stars
- (48,455 stars)
- PR merge metrics
- (平均マージ 6d 17h) (30d で 9 merged PRs)
説明
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 {