<var> (JavaScript)

Visual Studio 2017 RC の最新のドキュメントの詳細については、Visual Studio 2017 RC ドキュメントをご参照ください。

変数のドキュメント情報を指定します。

構文

<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
省略可能。 変数のデータ型。 型は以下のいずれかです。

  • NumberObject など、ECMAScript 5 仕様に含まれる ECMAScript 言語の型。

  • HTMLElementWindowDocument などの DOM オブジェクト。

  • JavaScript のコンストラクター関数。

    integer
    省略可能。 typeNumber である場合に、変数が整数かどうかを指定します。 変数が整数であることを示す場合は 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
    省略可能。 typeArray であれば、この属性は、配列内の要素の型を指定します。

    elementInteger
    省略可能。 typeArray であり、elementTypeNumber である場合、この属性は、配列内の要素が整数であるかどうかを指定します。 配列内の要素が整数であることを示す場合は true に設定します。それ以外の場合は false に設定します。 Visual Studio では、この属性は IntelliSense 情報を提供するためには使用されません。

    elementDomElement
    省略可能。 この属性は廃止されました。この属性より elementType 属性が優先されます。 typeArray である場合、この属性は、配列内の要素が DOM 要素であるかどうかを指定します。 要素が DOM 要素であることを指定する場合は true に設定します。それ以外の場合は false に設定します。 elementType 属性が設定されておらず elementDomElementtrue に設定されている場合、IntelliSense の入力候補機能では、配列内の各要素が HTMLElement として処理されます。

    elementMayBeNull
    省略可能。 typeArray である場合、配列内の要素を null に設定できるかどうかを指定します。 配列内の要素を null に設定できることを示す場合は true に設定します。それ以外の場合は false に設定します。 既定値は false です。 Visual Studio では、この属性は IntelliSense 情報を提供するためには使用されません。

    helpKeyword
    省略可能。 F1 ヘルプのキーワード。

    locid
    省略可能。 変数に関するローカライズ情報用の識別子。 この識別子は、メンバーの ID であるか、または OpenAjax のメタデータで定義されているメッセージ バンドル内の name 属性値に対応します。 この識別子の型は、<loc> タグで指定された形式によって異なります。

    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;  
    }  
}  

参照

XML ドキュメント コメント