是否可以在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 ...
 */