Microsoft/TypeScript

Doc comment applied to all components of dotted namespace declaration

Open

#13,855 opened on Feb 2, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
BugDomain: JSDocHelp Wanted

Description

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

Contributor guide

Tech stack
typescript
Domain
developer experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript compiler internalsJSDocnamespace resolution
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
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.