Microsoft/TypeScript

Doc comment applied to all components of dotted namespace declaration

Open

#13,855 创建于 2017年2月2日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)TypeScript (48,455 star) (6,726 fork)batch import
BugDomain: JSDocHelp Wanted

描述

TypeScript Version: 2.1.5, 2.2-rc

Code

/** Performance measurements for the compiler. */
namespace ts.performance {}

Expected behavior: The doc comment should show up in quickinfo/completion for references to the innermost declared namespace performance, but not for ts.

Actual behavior: The doc comment appears in quickinfo/completion for references to both performance and ts, even though for the outer namespace ts it's most likely irrelevant: jsdoc

贡献者指南

技术栈
typescript
领域
developer experience
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
TypeScript compiler internalsJSDocnamespace resolution
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
25
研究方向
Investigate how the TypeScript compiler attaches JSDoc comments to namespace symbols in src/compiler/checker.ts. The issue is that a comment on a dotted namespace declaration like namespace ts.performance {} is incorrectly propagated to the outer namespace. Look at the logic that creates namespace symbols and how comment associations are resolved. Consider checking the symbol creation for dotted namespaces and ensure comments are only assigned to the innermost symbol.