如何让VS Code了解JSDOC跨多个文件的@typedef

Question

我想在一个文件中指定一个类型,并能够在另一个文件中重用它.我尝试过模块,但它在VS Code中不起作用.还有其他解决方案吗？我想让我的项目的所有类型都可以重用,这样我就可以跨文件在不同的函数中引用它们.这是我发现的最接近的问题.

Answer 1

I've had some success with using jsconfig.json and its include property in a plain JavaScript project in Visual Studio Code 1.33.1

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

Given the following JavaScript project:

src/
??? types/
|   ??? person.js
|   ??? question.js
|
??? answer.js
??? jsconfig.json

其中question.js和person.js是类型定义：

person.js

src/
??? types/
|   ??? person.js
|   ??? question.js
|
??? answer.js
??? jsconfig.json

Question.js

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

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

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

正如您在第一个屏幕录像中看到的那样，将鼠标悬停在Question类型符号上时，我确实获得了IntelliSense支持：

最重要的是，IntelliSense现在还能够根据我的类型定义提供代码完成：

Answer 2

由于TypeScript 2.9嵌入在较新的VS Code中，因此可以通过使用importJSDoc中的语法来实现，就像这样

/**
 * @typedef {import("koa").Context} Context
 *
 * @typedef {Object} BodyparserOptions
 * @prop {(ctx: Context) => boolean} [detectJSON] Custom json request detect function. Default `null`.
 */

同样，VS Code应该选择整个工作空间中定义的所有类型。