<var> (JavaScript)
変数のドキュメント情報を指定します。
<var type="ValueType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" helpKeyword="keyword" locid="descriptionID">description</var>
パラメーター
type
省略可能。変数のデータ型。型は、次のいずれかの値:Number と Objectなどの ECMAScript 5 仕様に、ECMAScript 言語形式。
HTMLElement、Windowと Documentなどの DOM オブジェクト。
JavaScript のコンストラクター関数。
integer
省略可能。type が Number場合、変数が整数であるかどうかを指定します。変数が整数であることを示すに true に設定します; それ以外 falseに設定します。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。domElement
省略可能。この属性は避けてください; type の属性がこの属性より優先されます。この属性は文書化されている変数が DOM 要素であるかどうかを指定します。変数が DOM 要素であることを指定するに true に設定します; それ以外 falseに設定します。type の属性が設定されていない場合、domElementtrueがに設定されている場合、IntelliSense は HTMLElement として、ステートメント入力候補を実行するときに記載された変数を処理します。mayBeNull
省略可能。文書化されている変数が null に設定できるかどうかを指定します。変数が null に設定できることを示すために true に設定します; それ以外 falseに設定します。既定値 false です。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。elementType
省略可能。type が Arrayの場合、この属性は配列の要素の型を指定します。elementInteger
省略可能。type が Array 場合、elementType が Numberの場合、この属性は配列の要素が整数であるかどうかを指定します。配列の要素が整数であることを示すために true に設定します; それ以外 falseに設定します。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。elementDomElement
省略可能。この属性は避けてください; elementType の属性がこの属性より優先されます。type が Arrayの場合、この属性は配列の要素が DOM 要素であるかどうかを指定します。要素が DOM 要素であることを指定するに true に設定します; それ以外 falseに設定します。elementType の属性が設定されていない場合、elementDomElementtrueがに設定されている場合、IntelliSense は HTMLElement として、ステートメント入力候補を実行するときに配列の各要素を処理します。elementMayBeNull
省略可能。type が Array場合、配列の要素が null に設定できるかどうかを指定します。配列の要素が null に設定できることを示すために true に設定します; それ以外 falseに設定します。既定値 false です。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。helpKeyword
省略可能。F1 ヘルプのキーワード。locid
省略可能。変数に関する情報のローカリゼーションの識別子。この識別子は、メンバーの ID であるか、または OpenAjax のメタデータで定義されているメッセージのバンドルの name の属性値に対応します。識別子の型は <loc> (JavaScript) のタグで指定されている形式によって異なります。description
省略可能。変数の説明。
使用例
次のコード例に <var> の要素を使用する方法を示します。
/// <var>A rectangle that has a width of 5.</var>
var Rectangle = {
/// <field type = 'Number'>The width of the rectangle.</field>
wid: 5,
/// <field type = 'Number'>The length of the rectangle.</field>
len: 0,
/// <field type='Number'>Returns the area of the rectangle.</field>
getArea: function (wid, len) {
return len * wid;
}
}