javascript - 使用 JSDoc 3 语法指定对象类的正确方法是什么？

Question

如果我的代码创建了一个 pre-ecmascript 6 样式的“类”，即像这样的构造函数:

function MyDBPlugin() {
    // ...
}

我正在使用 JSDoc3计划记录另一个采用 MyDBPlugin 实例作为参数的函数，我如何表示 MyDBPlugin 对象？
我的第一个猜测是:

/**
 * Some function which takes an instance of MyDBPlugin as an argument
 *
 * @param {Object} plugin An instance of the MyDBPlugin class
 */
function query_database(plugin) {
    // ...
}

但是 {Object} 似乎信息量很小，似乎使用类名 {MyDBPlugin} 会更具描述性，例如:

/**
 * Some function which takes an instance of MyDBPlugin as an argument
 *
 * @param {MyDBPlugin} plugin An instance of the MyDBPlugin class
 */
function query_database(plugin) {
    // ...
}

如何在 JSDoc 语法中表示 MyDBPlugin 对象？

Answer 1

来自文档:http://usejsdoc.org/tags-type.html

如果它是一个类，您可以直接使用它:

/**
* @param {myNamespace.MyClass}
*/

如果是结构体，您可以创建自己的@typedef http://usejsdoc.org/tags-typedef.html并以与上面或您提到的相同的方式使用它:

/**
* Some function which takes an instance of MyDBPlugin as an argument
*
* @param {MyDBPlugin} plugin An instance of the MyDBPlugin class
*/
function query_database(plugin) {
  // ...
}