Microsoft/TypeScript

Doc comment applied to all components of dotted namespace declaration

Open

#13,855 opened on 2017年2月2日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.