<field> (JavaScript)
Określa informacje dotyczące dokumentacji, łącznie z opisem, dla pola lub element członkowski, który jest zdefiniowany dla obiektu.
<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>
Parametry
name
Nazwa pola lub członka.Gdy <field> element jest używany w funkcji konstruktora, name jest wymagana i definiuje element, do którego stosuje się znacznik.Gdy <field> element jest bezpośrednio adnotacje pola, ten atrybut jest ignorowany i nazwa używana przez program Visual Studio jest nazwa rzeczywistej pola w kodzie źródłowym.static
Opcjonalne.Określa, czy pole jest członkiem funkcja konstruktora lub członkiem obiekt zwrócony przez funkcję konstruktora.Zestaw do true w leczeniu pole jako członek funkcji konstruktora.Zestaw do false w leczeniu pole jako członek obiekt zwrócony przez funkcję konstruktora.type
Opcjonalne.Typ danych pola.Typ może być jedną z następujących czynności:Języka ECMAScript typ specyfikacji ECMAScript 5, takie jak Number i Object.
A DOM object, such as HTMLElement, Window, and Document.
Funkcja konstruktora kodu JavaScript.
integer
Opcjonalne.Jeśli type jest Number, określa, czy pole jest liczbą całkowitą.Zestaw do true do wskazania, że pole jest liczbą całkowitą; w przeciwnym razie, zestaw do false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.domElement
Opcjonalne.Ten atrybut jest niezalecane; type atrybut ma pierwszeństwo przed ten atrybut.Ten atrybut określa, czy pole udokumentowane jest DOM element.Zestaw do true , aby określić, że pole jest elementem DOM; w przeciwnym razie, zestaw do false.Jeśli type atrybut nie jest ustawiona i domElement jest ustawiona true, IntelliSense traktuje udokumentowane pola jako HTMLElement podczas wykonywania instrukcji.mayBeNull
Opcjonalne.Określa, czy pole udokumentowane można ustawić na wartość null.Zestaw do true do wskazania, że pole można ustawić na wartość null; w przeciwnym razie, zestaw do false.Wartością domyślną jest false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.elementType
Opcjonalne.Jeśli type jest Array, ten atrybut określa typ elementów w tablicy.elementInteger
Opcjonalne.Jeśli type jest Array i elementType jest Number, ten atrybut określa, czy elementy w tablicy są liczby całkowite.Zestaw do true , aby wskazać, że elementy w tablicy liczb całkowitych; w przeciwnym razie, zestaw do false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.elementDomElement
Opcjonalne.Ten atrybut jest niezalecane; elementType atrybut ma pierwszeństwo przed ten atrybut.Jeśli type jest Array, ten atrybut określa, czy elementy w tablicy są elementy DOM.Zestaw do true do określenia, że elementy są elementy DOM; w przeciwnym razie, zestaw do false.Jeśli elementType atrybut nie jest ustawiona i elementDomElement jest ustawiona true, IntelliSense traktuje każdego elementu w tablicy jako HTMLElement podczas wykonywania instrukcji.elementMayBeNull
Opcjonalne.Jeśli type jest Array, określa, czy elementy w tablicy można ustawić na wartość null.Zestaw do true do wskazania, że elementy w tablicy można ustawić na wartość null; w przeciwnym razie, zestaw do false.Wartością domyślną jest false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.helpKeyword
Opcjonalne.Słowo kluczowe pomocy F1.locid
Opcjonalne.Identyfikator lokalizacji informacji o polu.Identyfikator jest element członkowski lub identyfikator odpowiada name wartość w pakiet komunikatu definiowane przez metadane OpenAjax atrybutu.Typ identyfikatora zależy od formatu określonego w <loc> (JavaScript) tag.value
Opcjonalne.Określa kod, które powinny być oceniane do użytku przez IntelliSense zamiast kodu funkcji.Dla <field>, ten atrybut jest obsługiwana dla funkcji konstruktora, ale nie jest obsługiwana dla literały obiektowe.Możesz użyć tego atrybutu jest podanie informacji typu typ pola jest niezdefiniowany.Na przykład, można użyć value=’1’ w leczeniu typ pola jako liczba.description
Opcjonalne.Opis pola.
Uwagi
name Atrybut jest wymagany, gdy jesteś dokumentujące pole w funkcji konstruktora.W innych scenariuszach, wszystkie atrybuty dla <field> elementu są opcjonalne.
Gdy jesteś dokumentujące funkcję konstruktora <field> element musi pojawić się bezpośrednio przed deklaracja pola.name Atrybutu musi odpowiadać nazwie pola, który jest używany w kodzie źródłowym.Dla członków obiektu name atrybut można pominąć, jeśli <field> element jest wyświetlany bezpośrednio przed deklaracją członka obiektu.
Przykład
Poniższy przykład kodu pokazuje, jak używać <field> element.
// 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;
}
Poniższy przykład pokazuje, jak używać <field> element z static atrybut ustawiony na 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.
Poniższy przykład pokazuje, jak używać <field> element z static atrybut ustawiony na 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.
Poniższy przykład pokazuje, jak używać <field> element z value atrybut.
function calculator(a) {
/// <field name='f' value='1'/>
}
new calculator().f. // Completion list for a Number.