Question

我想知道是否可以从一个模块链接到另一个模块的属性/方法。

到目前为止我尝试过的但是没有工作：

/**
 * {@link module:modules/modulName#id}
 */

我的模块遵循以下模式：

/**
 * @module modules/modulName
 */
define(function() {

    'use strict';

    /**
     * @alias module:modules/modulName
     */
    var module = {
        /** Initialisation */
        init: function() {}
    };

    return module;

});

有没有办法达到我想要的目的？

Answer 1

好的，我自己设法做了

/**
 * @module namespace/moduleName
 */

/**
 * @name module:namespace/moduleName#propName
 * @type {Object}
 */
const propName= {}

然后在另一个文件中，您可以参考：

/*
 * @see module:namespace/moduleName#propName
 */

如果@link具有该名称，则可以使用@type甚至@typedef。

使用PHPStorm进行测试，它可以正常工作。不知道自动生成的API使用JSDOC。

JSDOC：是否可以链接到模块属性？

1 个答案: