visual-studio-code - 如何让 VS Code 跨多个文件理解 JSDOC 的 @typedef

Question

我想在一个文件中指定一种类型，并能够在另一个文件中重用它。我试过 modules但它在 VS Code 中不起作用。还有其他解决方案吗？只是想让我的项目的所有类型都可以重用，这样我就可以跨文件在不同的函数中引用它们。 This is the closest question我已经找到。

Answer 1

我在使用 jsconfig.json 方面取得了一些成功和它的 include Visual Studio Code 1.33.1 中普通 JavaScript 项目中的属性

{
  "include": [
    "src/**/*.js"
  ]
}

给定以下 JavaScript 项目:

src/
├── types/
|   ├── person.js
|   ├── question.js
|
├── answer.js
├── jsconfig.json

凡两者 question.js和 person.js是类型定义:

人物.js

/**
 * @typedef {object} Person
 * @property {string} firstName
 * @property {string} lastName
 */

问题.js

/**
 * @typedef {object} Question
 * @property {Person} askedBy
 * @property {string} text
 */

和 answer.js是一个接受问题并返回答案的函数:

/**
 * Takes a question and return an answer
 * @param {Question} question 
 */
function answer(question) {
  return 42;
}

正如您在第一个截屏视频中看到的那样，当鼠标悬停在 Question 上时，我确实获得了 IntelliSense 支持。类型符号:



最重要的是，IntelliSense 现在还能够根据我的类型定义提供代码补全: