如何在不修改后一个的情况下使用 JSDoc 记录函数返回的函数？答案

【问题标题】：How to document a function returned by a function using JSDoc without modifying the latter one?如何在不修改后一个的情况下使用 JSDoc 记录函数返回的函数？
【发布时间】：2017-11-23 01:25:56
【问题描述】：

这个问题和another one on this site很相似，只是多了一个限制：我不能修改创建新函数的函数。

假设我们有一个名为 someObject 的对象和一个名为 addMethod 的方法，可用于为该对象创建新方法，如下所示：

someObject.addMethod( "methodName", function () {
    // Do some stuff here
} );

我想用 jsDoc 记录someObject，但我不能修改它，除非使用它的 addMethod 函数。有没有办法做到这一点？

【问题讨论】：

标签： javascript jsdoc3

【解决方案1】：

最后，我发现的唯一方法是不使用匿名函数，而是像这样使用 @memberof jsDoc 标签：

someObject.addMethod("publicName", myPublicMethod);

/**
 * @function
 * @memberof SimpleObject#
 * @desc
 * The description of myPublicMethod.
 *
 * @returns true if  can capture the display.
 */
function myPublicMethod() {

};

我以为我必须使用@memberof！（@memberof 的强制形式；注意感叹号），但这不是必需的。即使该函数未在 SomeObject 类中定义，它也可以工作。

【讨论】：