web-dev-qa-db-ja.com

jsdocの有効なパラメータータイプ

Jsdocのparamタグの有効なタイプのどこかにリストがありますか？例えば、

@param {type} myParam Some parameter description

numberやStringのようなものが有効であることは知っていますが、数値が整数であることを文書化する場合はどうでしょうか。 intは有効ですか？

私はいくつかのグーグルをしましたが、完全なリストを見つけることができないようです。

javascriptjsdoc
41
Jeff Storey

私が使用したJSドキュメンテーションツールは、コメントを文字列にトークン化するだけであり、{type}セクションに必要なものを入れることができます。

{Number}のようにしたい場合、または{integer}を指定できるように指定したい場合は、JavaScriptタイプを使い続けることができます。

@param {Number} myParam must be an integer

乾杯

28
hunterloftis

実際の質問に答えるために

Jsdocのparamタグの有効なタイプのどこかにリストがありますか？

@paramのドキュメントには here 組み込み型と " namepaths "を使用できることが記載されています（以前に作成/文書化した型と独自の型へのパス） @typeで宣言した型。

built-in Javascript typesを検索すると、次の結果が得られます。たとえば、 here の場合、プリミティブ型のリストが得られます。

  • ブール値
  • ヌル
  • Undefined
  • 数
  • ストリング
  • シンボル（ECMAScript 2015の新機能）
  • 対象

また、名前パスの例を次に示します。

  • exampleFunction
  • exampleClass＃someInstanceMember
  • exampleClass.staticMember
  • exampleClass〜innerMember

例えば。 @param {exampleClass} exampleParam Instance of your example class

12
Gyuri