Jsdocのparamタグの有効なタイプのどこかにリストがありますか?例えば、
@param {type} myParam Some parameter description
number
やString
のようなものが有効であることは知っていますが、数値が整数であることを文書化する場合はどうでしょうか。 int
は有効ですか?
私はいくつかのグーグルをしましたが、完全なリストを見つけることができないようです。
私が使用したJSドキュメンテーションツールは、コメントを文字列にトークン化するだけであり、{type}セクションに必要なものを入れることができます。
{Number}のようにしたい場合、または{integer}を指定できるように指定したい場合は、JavaScriptタイプを使い続けることができます。
@param {Number} myParam must be an integer
乾杯
実際の質問に答えるために
Jsdocのparamタグの有効なタイプのどこかにリストがありますか?
@param
のドキュメントには here 組み込み型と " namepaths "を使用できることが記載されています(以前に作成/文書化した型と独自の型へのパス) @type
で宣言した型。
built-in Javascript types
を検索すると、次の結果が得られます。たとえば、 here の場合、プリミティブ型のリストが得られます。
また、名前パスの例を次に示します。
例えば。 @param {exampleClass} exampleParam Instance of your example class