<field>(JavaScript)

문서 정보, 필드 또는 개체에 대해 정의 된 멤버에 대 한 설명을 포함 하 여 지정 합니다.

<field name="fieldName" static="true|false" type="FieldType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" helpKeyword="keyword" locid="descriptionID" value="code">description</field>

매개 변수

• name
  이름 필드 또는 멤버입니다.때의 <field> 요소는 생성자 함수에 사용 되는 name 필수적 요소 이며 태그가 적용 되는 멤버를 정의 합니다.경우는 <field> 요소 직접 필드 주석을 추가 하 고이 특성이 무시 되 고 소스 코드에서 실제 필드 이름을 사용 하 여 Visual Studio 이름입니다.

• static
  선택 사항입니다.필드가 생성자 함수 멤버 또는 구성원 개체의 생성자 함수에 의해 반환 된 여부를 지정 합니다.설정 true 필드가 생성자 함수를 구성원으로 취급 합니다.설정 false 필드는 생성자 함수에 의해 반환 되는 개체의 구성원으로 취급 합니다.

• type
  선택 사항입니다.필드의 데이터 형식입니다.형식은 다음 중 하나일 수 있습니다.

  • ECMAScript 언어는 ECMAScript 5 사양에 같은 입력 Number 및 Object.

  • 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) 태그입니다.

• value
  선택 사항입니다.함수 코드 대신 사용할 수 있도록 IntelliSense가 평가 해야 하는 코드를 지정 합니다.에 대 한 <field>,이 특성 생성자 함수에 대해 지원 되지만 개체 리터럴의 경우 지원 되지 않습니다.이 사용할 수 있는 특성은 필드 형식이 정의 되지 않은 경우 형식 정보를 제공 합니다.예를 들어, 사용할 수 있습니다 value=’1’ 필드 형식을 숫자로 취급 합니다.

• description
  선택 사항입니다.필드에 대해 설명 합니다.

설명

name 특성은 생성자 함수에 필드를 문서화 하는 경우 필수적 요소입니다.모든 시나리오에 대 한 모든 특성은 <field> 요소는 선택 사항입니다.

생성자 함수를 작성 하는 경우는 <field> 필드 선언 바로 전에 나타나야 합니다.name 특성이 소스 코드에 사용 되는 필드 이름과 일치 해야 합니다.개체 멤버에 대 한의 name 경우 특성을 생략할 수는 <field> 요소가 나타나는 개체 멤버 선언 바로 앞.

예제

다음 코드 예제에서는 사용 하는 방법을 보여 줍니다 있는 <field> 요소입니다.

// Use of <field> in an object definition.
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;
    }
}

// Use of <field> in a constructor function.
// The name attribute is required.
function Engine() {
    /// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
    this.HorsePower = 150;
}

다음 예제에서는 사용 하는 방법을 보여 줍니다.를 <field> 요소와의 static 특성을 설정 true.

function Engine() {
    /// <field name='HorsePower' static='true' type='Number'>static field desc.</field>
}

Engine.HorsePower = 140;
// IntelliSense on the field is available here.
Engine.  

다음 예제에서는 사용 하는 방법을 보여 줍니다.를 <field> 요소와의 static 특성을 설정 false.

function Engine() {
    /// <field name='HorsePower' static='false' type='Number'>Non-static field desc.</field>
}

Engine.HorsePower = 140;
var eng = new Engine();
// IntelliSense on the field is available here.
eng.  

다음 예제에서는 사용 하는 방법을 보여 줍니다 있는 <field> 요소와의 value 특성.

function calculator(a) {
    /// <field name='f' value='1'/>
}
new calculator().f.   // Completion list for a Number.

참고 항목

개념

XML 문서 주석(JavaScript)