使用jsdoc和es2015模块语法

时间:2016-04-30 07:13:11

标签: javascript ecmascript-6 jsdoc

使用es2015模块语法时,我在jsdoc 3.4.0中遇到两个小问题。

1)示例代码:

/** @module */

/** Example for a local function */
function localFUnction() {}

/** Example for an exported function */
function publicFunction() {
    localFUnction();
}

export default {
    publicFunction
};

结果:

Module: module/module
Methods
(inner) localFUnction()
Example for a local function

(inner) publicFunction()
Example for an exported function

并且无法识别函数publicFunction被导出并将两个函数都标识为内部。

2)示例代码:

/** @module */

/** Example for a local function */
function localFUnction() {}

/** Example for an exported function */
export function publicFunction() {
    localFUnction();
}

结果:

Module: module/module
Methods
(static) publicFunction()
Example for an exported function

(inner) localFUnction()
Example for a local function 

现在确实认识到导出语法put将公共函数标识为静态。

我不确定是否有问题,或者我只是以错误的方式使用它,我们非常感谢任何帮助。

0 个答案:

没有答案