如何在JSDoc中为回调函数参数自定义命名（替换arg0）？

要把VSCode自动生成的arg0改成自定义名称，只需在JSDoc的函数类型定义里明确指定参数名即可，以下是两种常用实现方式：

方法一：直接在@param的函数类型中指定参数名 #

将原注释里的function(*): *替换为function(自定义参数名: *): *，示例代码如下：

/**
 * @function foo
 * @param {function(自定义参数名: *): *} callback
 * @returns {*}
 */
function foo(callback){
    return callback()
}

修改后VSCode生成的类型声明会变为：function foo(callback: (自定义参数名: any) => any): any。

方法二：使用@callback定义独立回调类型 #

如果该回调类型需要复用，可以先通过@callback定义带命名参数的专属类型，再在@param中引用：

/**
 * @callback CustomCallback
 * @param {*} 自定义参数名 - 可在此添加参数的详细描述
 * @returns {*}
 */

/**
 * @function foo
 * @param {CustomCallback} callback
 * @returns {*}
 */
function foo(callback){
    return callback()
}

这种方式除了自定义参数名，还能给参数补充说明，代码可读性更强。

内容的提问来源于stack exchange，提问作者Axel Carré