JSDoc: ссылка @param метода в другом @param

Question

Я новичок в использовании JSDocs и не смог найти ответ на этот вопрос.

Предположим, я хотел написать эту простую функцию:

function hasQ(array, item) {return array.includes(item);}

который с JSDoc'ом я бы разметил как:

/**
* Another way to call array.includes(item);
* @param {Array} array
* @param {*} item to test if contained in array
* @returns
*/

Есть ли способ для меня разметить слово array во втором @param выражении так, чтобы оно ссылалось на первое @param?

Это просто игрушечный пример, но я надеюсь, что это прояснит концепцию.

Answer 1

Я не видел возможности записи связанных параметров (но вижу параметры со свойствами ). Но вы можете написать описание;)

/**
 * @method
 * @param {Array} array - description for this param
 * @param {*} item - description for this param
 * @description Please write your description for Method
 * @returns {*|boolean}
 */
const hasQ = (array, item) => array.includes(item);