microsoft / microsoft/TypeScript
Inherited methods not merging JSDoc comments
未关闭
还没有人认领这个 Issue。
Suggestion
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.3k
- 平均合并
- 2 天 4 小时
- 30 天内合并 PR
- 132
描述
Steps to reproduce
class Foo {
/** foo bar */
method(): void {}
}
class Bar extends Foo {
/** @remarks lorem ipsum */
method(): void {}
}
Behavior with typescript@5.9
Hovering over Bar#method gives:
(method) Bar.method(): void
foo bar
@remarks — lorem ipsum
Behavior with tsgo
Hovering over Bar#method gives:
(method) Bar.method(): void
@remarks — lorem ipsum
Note that the foo bar is gone. I believe that blocks like @remarks being merged is a case not handled by microsoft/typescript-go#2111
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
先从 issue 中的 TypeScript 5.9 和 tsgo 复现开始,然后阅读 microsoft/typescript-go#2111,了解相关的 JSDoc 合并行为。比较继承方法文档的处理方式,并确保补全会一致地合并 foo bar 文本和 @remarks 块。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- go, typescript
- 领域
- compilers
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100