98

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

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

5 に答える 5

115

クロージャーコンパイラ

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

概要

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

于 2013-12-18T05:04:35.460 に答える
106

JsDocのタイプのセットから選択する必要はないと思います...任意のタイプ名を使用できます（中括弧はタイプであることを示します）ので、次のようにするだけです。

@return {void}

ただし、これはおそらくJavaScriptの方が正しいでしょう。

@return {undefined}
于 2011-01-21T13:20:56.213 に答える
24

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

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

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

于 2017-08-02T02:29:24.827 に答える
1

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

/**
 * This is a funny function. Returns nothing.
 * @param {string} a joke.
 */
var funny = function (joke) {
  console.log(joke);
};
于 2015-03-10T08:24:21.243 に答える
0

私はこれを除外するよりも曖昧さが少ないと思います@returns：

@returns {} Nothing is returned.

あるいは

@returns {} Nothing is returned because this is a broadcast receiver.

ただのアイデア。

于 2021-11-20T22:22:51.690 に答える