JSDoc：Node.js require 语句替换类定义

Question

在我的 Node.js 项目中，我有正常的类定义，例如：

/**
 * My awesome class.
 * @constructor
 */
var MyClass = function MyClass() {}

在另一个文件中我需要它：

var MyClass = require('./myclass.js').MyClass;

但有时 JSDoc 会找到 require 语句，并且只将 MyClass 记录为全局变量。 如何让 JSDoc 始终记录类定义并忽略 require 语句中定义的变量？

Answer 1

将代码作为模块而不是 CommonJS...

import MyClass from '...';

或者...

import { MyClass } from '...';

这会很好用。

你的方法不起作用，因为 JSDoc 将查找 const docblock 而不是你的类 docblock...

/**
 * JSDoc looks for this docblock in this file...
 * Not the docblock in `require().MyClass`...
 */
const MyClass = require('...').MyClass;