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

时间:2018-08-27 14:15:23

标签: jsdoc jsdoc3

给出如下模块:

/** 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;
    }

我似乎无法让Config注册为链接

1 个答案:

答案 0 :(得分:0)

带有module:的简单前缀

见下文

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