Как вернуть void в JsDoc?

Question

Как вернуть void в JsDoc?

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

/**

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

 */

623 4

javascript ide jsdoc

4 ответов:

Comments

Ничего не найдено.

David Tang · Accepted Answer · 2011-01-21 15:20:56

Я не считаю, что вы должны выбрать из набора типов в JsDoc... вы можете использовать любое имя типа, которое вы хотите (фигурные скобки указывают, что это тип), так что вы можете просто сделать:
@return {Void}
хотя, это, вероятно, более правильно для JavaScript:
@return {undefined}

Brent Robinson · Accepted Answer · 2013-12-18 07:04:35

Компилятора

согласно документации компилятора закрытия Google, если ничего не возвращается, аннотация @return должна быть опущена.

Если нет возвращаемого значения, не используйте тег @return.

источник:https://developers.google.com/closure/compiler/docs/js-for-compiler#tags

jsdoc-Toolkit и

однако в дальнейшей документации также говорится, что в тип_возвращаемого_значения и returnDescription являются необязательными параметрами.

returnType-необязательно: тип возвращаемого значения.

returnDescription-необязательно: любое дополнительное описание.

источник:https://code.google.com/p/jsdoc-toolkit/wiki/TagReturns

резюме

вы можете либо оставить аннотацию возврата, либо включить ее без каких-либо параметров.

primetimejas · Accepted Answer · 2017-08-02 05:29:24

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

Источник:http://eslint.org/docs/rules/valid-jsdoc

Так как мне нужно предоставить @returns для каждой функции, чтобы пройти тесты для того, чтобы нажать код для определенных проектов это требуется в моем случае.

Akseli Palén · Accepted Answer · 2015-03-10 10:24:21

Если вам нужно сказать вслух, что ничего не возвращается, вы можете сказать, что в свободной форме описание. Это полезно для прояснения ситуаций, когда пользователь может ожидать, что что-то будет возвращено. Конечно правильное наименование функции и параметров должен только сделать ожидаемый тип возврата очевидным, но это не всегда возможно.
/**
 * This is a funny function. Returns nothing.
 * @param {string} a joke.
 */
var funny = function (joke) {
  console.log(joke);
};