JavaScriptのドキュメントコメントでは、JSDocコメントを使用してパラメータの型を表現します¹²。特定の文字列のみを受け入れるパラメータの型を表現する場合は、以下のように記述することができます：
/**
* 何かの関数
* @param {('out'|'err')} param - 'out'または'err'の文字列
*/
function someFunction(param) {
// 関数の内容
}
この例では、paramパラメータは'out'または'err'の文字列のみを受け入れます。他の値が渡されると、型チェックに失敗します。このように、JSDocコメントを使用すると、JavaScriptのコードに型情報を追加することができ、コードの可読性と保守性を向上させることができます¹²。ただし、JavaScript自体は動的型付け言語であるため、実行時に型チェックは行われません。型チェックは、エディターやIDE、あるいはTypeScriptのような静的型付け言語を使用することで可能になります¹²。このため、JSDocコメントはあくまで開発者のためのヒントであり、実際のプログラムの動作には影響を与えません¹²。また、JSDocコメントはエディターによってはコード補完やヒント表示の機能を提供します¹²。これにより、開発者はコードの記述を助けられ、ミスを防ぐことができます¹²。ただし、すべてのエディターがJSDocコメントをサポートしているわけではないため、使用するエディターによってはこの機能が利用できない場合もあります²。具体的な使用方法やエディターのサポート状況については、各エディターの公式ドキュメンテーションを参照してください³。¹²。³。
ソース: Bing との会話 2023/12/12 (1) 【JavaScript】＠type や @paramとは【JSDocコメント】 - 紺 .... https://www.woochanstudy.com/jsdoc_comment/. (2) JavaScriptでJSDocコメントを書くメリットとは - ICS MEDIA. https://ics.media/entry/6789/. (3) JSDoc comments | WebStorm Documentation - JetBrains. https://www.jetbrains.com/help/webstorm/creating-jsdoc-comments.html.