“复制”源为变量的对象成员的 JSDoc

Question

我有一个用 JSDoc 记录的函数，然后通过对象文字导出该函数（因为该函数需要通过初始化传入的模块级数据）。

如何将函数的文档转发到导出的对象文字，从而使其可用于导入代码？

sumPrinter.ts

：

export default (n: number, m: number) => {
    /**
     * Prints the sum of the two numbers
     */
    const printSum = () => { 
        console.log(n + m)
    }

    return {
        printSum
    }
}

和

main.ts

：

import sumPrinter from './sumPrinter.js'

const { printSum } = sumPrinter(5, 7)
printSum()

换句话说，当将鼠标悬停在

printSum

中的

main.ts

上时，我希望看到函数本身定义的 JSDoc，而不是重复 JSDoc 两次。

Answer 1

您可以将其添加到返回值中，如下所示：

export default (n: number, m: number) => {
    const printSum = () => { 
        console.log(n + m)
    }

    return {
        /**
         * Prints the sum of the two numbers
         */
        printSum
    }
}