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

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

65 голосов
/ 21 января 2011

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

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

Ответы [ 4 ]

92 голосов
/ 18 декабря 2013

Закрывающий компилятор

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

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

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

jsdoc-toolkit

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

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

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

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

Сводка

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

71 голосов
/ 21 января 2011

Я не думаю, что вам нужно выбирать из набора типов в JsDoc ... вы можете использовать любое имя типа по вашему желанию (фигурные скобки указывают, что это тип), поэтому вы можете просто сделать:

@return {Void}

Хотя это, вероятно, более правильно для JavaScript:

@return {undefined}
6 голосов
/ 02 августа 2017

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

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

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

1 голос
/ 10 марта 2015

Если вам нужно сказать вслух, что ничего не возвращено, вы можете сказать, что в описании произвольной формы .Это полезно для выяснения ситуаций, когда пользователь может ожидать, что что-то будет возвращено.Конечно, правильное именование функции и параметров должно само по себе сделать ожидаемый тип возвращаемого значения очевидным, но это не всегда возможно.

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