JavaScriptにおいて、関数の直前に記述するコメントは、JSDocコメントと呼ばれます。JSDocコメントは、関数や変数の宣言の直前に /** と */ で囲まれたコメントを記述することで、プログラムの可読性を高めることができます。JSDocコメントには、関数の説明や引数の説明、戻り値の説明などを記述することができます。以下は、JSDocコメントの例です。
/**
* 関数の説明
* @param {型} 引数名 引数の説明
* @return {型} 戻り値の説明
*/
function myFunction(arg1, arg2) {
// 関数の処理
}
JSDocコメントでは、@param や @return などのキーワードを使用して、引数や戻り値に関する情報を記述することができます。また、型情報も記述することができます。JSDocコメントを使用することで、コードエディター上で関数や変数にマウスオーバーした際に、関数や変数の説明が表示されるようになります。¹²³
ソース: Bing との会話 2023/10/20 (1) JavaScriptでJSDocコメントを書くメリットとは - ICS MEDIA. https://ics.media/entry/6789/. (2) 初心者がJSDocを調べてみた #JavaScript - Qiita. https://bing.com/search?q=Javascript+関数+コメント. (3) 初心者がJSDocを調べてみた #JavaScript - Qiita. https://qiita.com/tarotaro1129/items/c7b742f3602c7749a29d. (4) JavaScriptのコーディング規約【プログラミング初心者向け教材】. https://tokitsubaki.com/javascript-style-guide/270/. (5) 変数の説明を JSDoc で書く #JavaScript - Qiita. https://qiita.com/azujuuuuuun/items/95c762d5f4094770820b.
JavaScriptにおいて、関数の戻り値が特定のデータまたはundefinedだった場合、JSDocコメントでは@returnキーワードを使用して、戻り値に関する情報を記述することができます。以下は、JSDocコメントの例です。
/**
* 関数の説明
* @param {型} 引数名 引数の説明
* @return {型} 戻り値の説明
*/
function myFunction(arg1, arg2) {
// 関数の処理
if (/* 戻り値が特定のデータ */) {
return /* 特定のデータ */;
} else {
return undefined;
}
}
JSDocコメントでは、@returnキーワードを使用して、戻り値に関する情報を記述することができます。また、型情報も記述することができます。JSDocコメントを使用することで、コードエディター上で関数や変数にマウスオーバーした際に、関数や変数の説明が表示されるようになります。¹²³
ソース: Bing との会話 2023/10/20 (1) javascriptで戻り値を指定しているのにUndefinedになる. https://teratail.com/questions/362166. (2) JavaScript | 関数から呼び出し元へ値を返す(return). https://www.javadrive.jp/javascript/function/index4.html. (3) javascript - 文字列を返すメソッドで値がない場合、 null .... https://ja.stackoverflow.com/questions/65698/文字列を返すメソッドで値がない場合-null-undefined-空文字列のいずれを返すべきか. (4) 変数が「undefined」になる事例と対処方法 | GRAYCODE .... https://gray-code.com/javascript/example-where-the-variable-become-undefined/. (5) 【JavaScript入門】undefined徹底解説！使い方や判定方法 .... https://www.sejuku.net/blog/28461.