如何将函数arugument文档化，它本身就是一个JavaScript中带有参数的函数

Question

如何对函数本身的参数进行文档字符串处理？

示例：

/**
* 
* @param secondFunction // I want to say this should be a function that accepts a number
*/
function firstFunction(secondFunction) {
const a = 1;
secondFunction(a);
}

干杯！

Answer 1

您可以将参数的类型定义为期望传递的函数签名：

/** Calls second function with 1
* @param {(a:number)=>void} secondFunction
*/
function firstFunction(secondFunction) {
const a = 1;
secondFunction(a);
};

Answer 2

来自JSDoc文档：

回调函数

如果参数接受回调函数，则可以使用@callback标记来定义回调类型，然后将回调类型包含在@param标记中。

接受回调的参数

/**
* This callback type is called `secondFunction` and is displayed as a global symbol.
*
* @callback secondFunction
* @param {number} a
*/
/**
* executes secondFunction
* @param {secondFunction} secondFunction - The callback
*/
function firstFunction(secondFunction) {
const a = 1;
secondFunction(a);
};