是否可以在 JSDoc 中记录未在本地定义的函数？

Question

我的代码中有几次基本模式是exports.thing = thingFromSomewhereElse，我想记录thingFromSomewhereElse 的函数成员，就好像我自己定义了它们一样。但是如果没有实际的thing.functionName = function() {...}，我看不到该怎么做。如果我尝试使用@callback 标记，JSDoc 会将其归类为类型定义而不是成员。有没有办法让它正确显示为对象成员？

Answer 1

这可以通过使用@name JSDoc 标记来完成。该标签旨在用于为 JSDoc 无法识别的内容编写注释。 @kind 标签也应该用来表示被记录的东西实际上是一个函数，这样像 @param 和 @return 这样的特定于函数的标签才能正常工作。对于给出的示例，该函数将使用如下注释记录：

/**
 * Description of the function
 * @name thing.functionName
 * @kind function
 * @param ...
 * @return ...
 */