microsoft / microsoft/TypeScript
IntelliSense Parses JSDoc Namepath Part "module" as a Actual Module File Path
@sandersn がすでに取り組んでいます。
2019年4月16日 から。
- 主要言語
- 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:
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
評価
この issue はまだ評価されていません。