microsoft / microsoft/TypeScript

IntelliSense Parses JSDoc Namepath Part "module" as a Actual Module File Path

オープン
#30,893 コメント 1 件 リアクション 0 件 担当者 1 名 GitHub で見る

@sandersn がすでに取り組んでいます。

2019年4月16日 から。

Needs Investigation
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

- VSCode Version: 1.34.0-insider
- OS Version: 10.14.3 (18D109)
- Does this issue occur when all extensions are disabled?: Yes

Background

JSDoc uses namepaths to link variables in documentation. If you use the @module block to contain variables, then referencing those variables requires using the module: part in your namepaths.

Problem

When using JSDoc namepaths involving the 'module' part, VSCode displays the module's file path within IntelliSense. I think as a result the signature's return value is also wrong, instead displaying the module's exported functions.

Screenshot of issue:

Screen Shot 2019-04-12 at 12 44 19 PM

Is there a way to escape that module keyword? Or some way to write it so it works with VSCode? Using the full module namepath in JSDoc is required to reference types defined within module blocks, as described here https://github.com/jsdoc3/jsdoc/issues/969 and here https://github.com/jsdoc3/jsdoc/issues/1533.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。