Как я могу документировать аргумент, который сам является функцией?
Пример:
/**
*
* @param secondFunction // I want to say this should be a function that accepts a number
*/
function firstFunction(secondFunction) {
const a = 1;
secondFunction(a);
}
Ваше здоровье!
@evolutionxbox Я использую 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);
};
Вы можете определить тип параметра как сигнатуру функции, которую вы ожидаете передать:
/** Calls second function with 1
* @param {(a:number)=>void} secondFunction
*/
function firstFunction(secondFunction) {
const a = 1;
secondFunction(a);
};
Это тоже очень хорошо!
Какую аннотацию вы используете? JSDoc? ЕСДок? Если это JSDoc, взгляните на их документацию jsdoc.app/tags-param.html#callback-функции.