JSDoc：嵌套函数的@type

Question

我有一个 factory 函数，它定义并返回其他函数 - myFunc。我想用 JSDocs 记录我的工作变量：

function factory() {
    function myFunc(param) {
        console.log(`Hello ${param}!`);
    }

    return myFunc;
}

/** @type {factory} */
const fact = factory;
/** @type {???} */
const fn = fact();
fn('world');

我可以记录factory函数：

/** @type {factory} */
const fact = factory;

但我的 IDE (IDEA PhpStorm) 无法以相同的方式解析内部函数：

/** @type {myFunc} */
const fn = factory();

在这种情况下，我无法使用 Ctrl+单击导航。是否存在解决内部功能的方法？嗯。喜欢factory#myFunc:

/** @type {factory#myFunc} */
const fn = factory();

Answer 1

可以在嵌套函数上使用@exports directive：

function factory() {
    /** @exports myFunc */
    function myFunc(param) {
        console.log(`Hello ${param}!`);
    }
    return myFunc;
}

/** @type {factory} */
const fact = factory;
/** @type {myFunc} */
const fn = fact();
fn('world');

Answer 2

您的 factory 返回一个函数，该函数接受一个字符串但什么也不返回。

这可以通过使用@return标签的类型表达式来表达：

/** @return {function(string): void} */
function factory() {
  function myFunc(param) {
    console.log(`Hello ${param}!`);
  }
  return myFunc;
}

如果x 被分配了factory() 的结果，您的I​​DE 应该能够计算出它的类型：