web-dev-qa-db-ja.com

JsDocでvoidを返す方法は？

JsDocでvoidを返すメソッドまたは関数を宣言する特定の方法はありますか？現在、voidがデフォルトの戻り値であり、他の戻り値を具体的に提供する必要があると考えています。

/**
 * @return {Integer} The identifier for ...
 */
javascriptidejsdoc
66
Tower

JsDocの一連のタイプから選択する必要はないと思います...希望する任意のタイプ名を使用できます（中括弧はそれがタイプであることを示します）。

@return {Void}

ただし、これはおそらくJavaScriptの場合により正確です。

@return {undefined}
73
David Tang

クロージャコンパイラ

GoogleのClosure Compilerのドキュメントによると、何も返されない場合、@ 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

概要

リターンアノテーションを省略するか、パラメータなしで含めることができます。

94
Brent Robinson

彼らが使用するESlintドキュメントを見る@returns {void}

ソース： http://eslint.org/docs/rules/valid-jsdoc

特定のプロジェクトのコードをプッシュするためにテストに合格するには、各関数に@returnsを提供する必要があるため、これは私の場合に必要です。

6
primetimejas

何も返されないことを大声で言う必要がある場合は、自由形式の説明でと言うことができます。これは、ユーザーが何かが返されることを期待する状況を明確にするのに役立ちます。もちろん、関数とパラメーターの適切な命名だけで、期待される戻り値の型が明らかになりますが、常に可能であるとは限りません。

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