jsdoc - 如何在 JSDocs 中将模块作为参数引用

Question

给定一个模块，如：

/** Config module
 * @module Config
 */
export default class Config {
...

当指定为参数时，如何指定到 Config 模块的链接？

/**
 * Foo
 * @module Foo
 */
export default class Foo {
    /**
     * Create a new instance
     * @constructor
     * @param {Config} config - the config
     */
    constructor(config) {
        this.config = config;
    }

我似乎无法让配置注册为链接

标签： jsdocjsdoc3

Answer 1

简单的前缀module:

见下文

/**
 * Foo
 * @module Foo
 */
export default class Foo {
    /**
     * Create a new instance
     * @constructor
     * @param {module:Config} config - the config
     */
    constructor(config) {
        this.config = config;
    }