如何在对象属性中转发TSDoc描述

Question

例如，我有一个函数：

/**
 * Function returns null
 */
const myFunction = () => {
  return null
}

像这样的物体：

const internals = {
  myFunction: myFunction,
}

因此，我希望看到这样的描述:在internals.myFunction的VScode中，“函数返回null”。

但是对于诸如“inheritDoc”、“链接”之类的符号，我只看到它们是这样的：{@inheritDoc myFunction}

我想用所有必要的文档生成一个坚实的d.ts。

有可能吗？

Answer 1

所以我看了一眼反应源，有一种方法：

假设函数位于my-function.ts文件中

/**
 * Function returns null
 */
export const myFunction = () => {
  return null
}

然后，我像这样重新导出我的所有功能：

functions.ts

import {myFunction} from './my-function'
import {myFunction2} from './my-function2'
// and other imports

export {
  myFunction,
  myFunction2,
}

最后：

internals.ts

import * as functions from './functions'

const internals = {
  functions,
}

因此，通过这种方式，我终于可以看到“函数返回空”在

internals.functions.myFunction

因此，请查看我的代码框中的示例