Чи є вказаний спосіб оголосити метод або функцію для повернення void у JsDoc? В даний час я впевнений, що voidзначення за замовчуванням повертається, і інші значення, що повертаються, повинні бути вказані спеціально:

/**
 * @return {Integer} The identifier for ...
 */

Я не вірю, що вам потрібно вибирати з набору типів у JsDoc ... ви можете використовувати будь-яке ім’я типу, яке хочете (фігурні дужки вказують, що це тип), тому ви можете просто зробити:

@return {Void}

Хоча, це, мабуть, правильніше для JavaScript:

@return {undefined}

Компілятор закриття

Відповідно до документації компілятора закриття Google, якщо нічого не повертається, анотацію @return слід опустити.

Якщо значення повернення немає, не використовуйте тег @return.

Джерело: https://developers.google.com/closure/compiler/docs/js-for-compiler#tags

jsdoc-інструментарій

Однак у подальшій документації також зазначено, що returnType та returnDescription є необов'язковими параметрами.

returnType - Необов'язково: тип значення, що повертається.

returnDescription - Необов’язково: будь-який додатковий опис.

Джерело: https://code.google.com/p/jsdoc-toolkit/wiki/TagReturns

Резюме

Ви можете залишити анотацію повернення або включити її без будь-яких параметрів.

Переглядаючи документи ESlint, якими вони користуються @returns {void}

Джерело: http://eslint.org/docs/rules/valid-jsdoc

Оскільки мені потрібно надати @returnsдля кожної функції проходження тестів, щоб підштовхнути код для певних проектів, це потрібно в моєму випадку.

Якщо вам потрібно вголос сказати, що нічого не повертається, ви можете сказати це в описі у вільній формі . Це корисно для роз'яснення ситуацій, коли користувач може очікувати, що щось буде повернуто. Звичайно, правильне іменування функції та параметрів повинно робити одне лише очевидним очікуваний тип повернення, але це може бути не завжди можливим.

/**
 * This is a funny function. Returns nothing.
 * @param {string} a joke.
 */
var funny = function (joke) {
  console.log(joke);
};