다음을 통해 공유


<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
    선택 사항입니다.변수의 데이터 형식입니다.형식이 다음 중 하나가 될 수 있습니다.

    • ECMAScript 5 사양에는 ECMAScript 언어 형식 NumberObject.

    • A DOM object, such as HTMLElement, Window, and Document.

    • JavaScript 생성자 함수입니다.

  • integer
    선택 사항입니다.경우 type 는 Number, 변수 정수 인지 여부를 지정 합니다.설정 true 변수는 정수가 고, 표시 하려면 그렇지 않으면 설정 false.이 특성 IntelliSense 정보를 제공 하 여 Visual Studio 사용 되지 않습니다.

  • domElement
    선택 사항입니다.이 특성은 사용 되지 않습니다. type 특성이이 특성 보다 우선 합니다.이 특성 변수 문서화 된 DOM 요소 인지 여부를 지정 합니다.설정 true 변수는 DOM 요소의 지정 하려면 그렇지 않으면 설정 false.경우는 type 특성이 설정 되어 있지 및 domElement 설정 true, IntelliSense로 문서화 된 변수 처리는 HTMLElement 문 완성 기능을 수행 하는 경우.

  • mayBeNull
    선택 사항입니다.문서화 된 변수를 설정할 수 있는지 여부를 지정 하려면 null입니다.설정 true 변수를 설정할 수 있습니다 나타내려면 null입니다. 그렇지 않으면 설정 false.기본값은 false입니다.이 특성 IntelliSense 정보를 제공 하 여 Visual Studio 사용 되지 않습니다.

  • elementType
    선택 사항입니다.경우 type 는 Array, 배열에 있는 요소의 형식을이 특성을 지정 합니다.

  • elementInteger
    선택 사항입니다.경우 type 입니다 Array 및 elementType 입니다 Number, 정수 배열의 요소 인지이 특성을 지정 합니다.설정 true ; 정수 배열의 요소 임을 나타내려면 그렇지 않으면 설정 false.이 특성 IntelliSense 정보를 제공 하 여 Visual Studio 사용 되지 않습니다.

  • elementDomElement
    선택 사항입니다.이 특성은 사용 되지 않습니다. elementType 특성이이 특성 보다 우선 합니다.경우 type 는 Array,이 특성을 배열에 있는 요소의 DOM 요소 인지 지정 합니다.설정 true DOM 요소; 요소 임을 지정 하려면 그렇지 않으면 설정 false.경우는 elementType 특성이 설정 되어 있지 및 elementDomElement 설정 true, IntelliSense로 배열의 각 요소를 처리는 HTMLElement 문 완성 기능을 수행 하는 경우.

  • elementMayBeNull
    선택 사항입니다.경우 type 입니다 Array, 배열의 요소를 설정할 수 있는지 여부를 지정 하려면 null.설정 true 배열의 요소를 설정할 수 있습니다 나타내려면 null입니다. 그렇지 않으면 설정 false.기본값은 false입니다.이 특성 IntelliSense 정보를 제공 하 여 Visual Studio 사용 되지 않습니다.

  • helpKeyword
    선택 사항입니다.F1 도움말 키워드입니다.

  • locid
    선택 사항입니다.변수에 대 한 지역화 정보에 대 한 식별자입니다.두 멤버의 식별자입니다 ID 또는 그에 해당 하는 name 특성 값 OpenAjax 메타 데이터에 의해 정의 된 메시지 번들에서.식별자 형식에 지정 된 형식에 따라 달라 집니다를 <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;
        }
    }

참고 항목

개념

XML 문서 주석(JavaScript)