JSDoc：如何讓 IntelliSense/TypeScript 了解其他文件中的類？

Question

我正在處理一個相對較大的項目，我想將 JSDoc 添加到我的類和文件中，使其更容易開發。 我的“配置”類/對象有一個 getter 函數，該函數返回其“SQLRegistry”對象的實例，該對象稍后在鏈中設置。

//configuration.js

/**
 * @returns {SQLRegistry} registry
 */
getRegistry() {
    return this._registry;
}

//sqlRegistry.js
const Configuration = require('./configuration');

class SQLRegistry {
    //other code
}

不幸的是，在帶有 IntelliSense/ESLint 的 VS Code 中，它提供了一個錯誤，指出它找不到類“SQLRegistry”。 在任何其他情況下，我只會將 sqlRegistry.js 導入 configuration.js，但在這種情況下我不能（因為 sqlRegistry 依賴於 configuration.js，如上所示）。

是否有某種 JSDoc 注釋可以放在文件頂部，告訴它讀取 sqlRegistry.js，以便它知道 SQLRegistry 類？ 例如，類似於：

/**
 * @include {@link ./sqlRegistry.js}
 */

Answer 1

您假設的@include {@link ./sqlRegistry.js}在原則上非常接近。

在 TypeScript 對 JSDoc 語法的解釋下寫這個的實際方法是

/**
 * @returns {import('./sqlRegistry.js')} registry
 */
getRegistry() {
    return this._registry;
}

請注意，實際上是 TypeScript 為 VS Code 的主要 JavaScript 功能（如類型推斷）提供支持，而不是 ESLint

這種在類型位置import('module-specifier')語法被稱為import types ，不要與Type only 導入混淆，它是在 TypeScript 2.9 中引入的。

這不是 JSDoc 特定的功能，而是來自 TypeScript。

TypeScript 語言服務識別 JSDoc 注釋位置中需要類型的語法。 請注意，官方TypeScript 手冊指出

您還可以使用導入類型從其他文件導入聲明。 此語法特定於 TypeScript，與 JSDoc 標准不同：