Microsoft/TypeScript

Type name in @throws not rendered as a link

Open

#59,578 创建于 2024年8月9日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)TypeScript (6,726 fork)batch import
Domain: JSDocHelp WantedPossible Improvement

仓库指标

Star
 (48,455 star)
PR 合并指标
 (平均合并 6天 17小时) (30 天内合并 9 个 PR)

描述

According to the JSDoc documentation you can put a type name after a @throws. Something like @throws {Error}. I would expect the type name to be rendered as a link, but it is rendered as {Error}

贡献者指南

研究方向
研究 TypeScript 的 JSDoc 解析器和渲染器如何处理带有类型名称的 @throws 标签，并修改渲染逻辑，将花括号内的类型名称转换为超链接。
技术栈
typescript
领域
documentation
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
TypeScriptJSDoc
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70