<var> (JavaScript)
Określa informacje dotyczące dokumentacji dla zmiennej.
<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>
Parametry
type
Opcjonalne.Typ danych zmiennej.Typ może być jedną z następujących czynności:Typ języka ECMAScript, który jest w specyfikacji ECMAScript 5, takich jak Number i Object.
A DOM object, such as HTMLElement, Window, and Document.
Funkcja konstruktora JavaScript.
integer
Opcjonalne.Jeśli type jest Number, określa, czy zmienna jest liczbą całkowitą.Ustaw true , aby wskazać, że zmienna jest liczbą całkowitą; w przeciwnym razie jest ustawiona na false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.domElement
Opcjonalne.Ten atrybut jest niezalecane; type atrybutu ma pierwszeństwo przed tego atrybutu.Ten atrybut określa, czy zmienna udokumentowane elementu DOM.Ustaw true , aby określić, że zmienna jest DOM element; w przeciwnym razie jest ustawiona na false.Jeśli type atrybut nie jest ustawiony i domElement jest ustawiona true, IntelliSense traktuje udokumentowane zmienną jako HTMLElement podczas wykonywania instrukcji.mayBeNull
Opcjonalne.Określa, czy zmienna udokumentowane można ustawić na wartość null.Ustaw true do wskazania zmiennej można ustawić wartość NULL; w przeciwnym razie jest ustawiona na false.Wartością domyślną jest false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.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.Ustaw true , aby wskazać, że elementów w tablicy liczb całkowitych; w przeciwnym razie jest ustawiona na false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.elementDomElement
Opcjonalne.Ten atrybut jest niezalecane; elementType atrybutu ma pierwszeństwo przed tego atrybutu.Jeśli type jest Array, ten atrybut określa, czy elementy w tablicy są elementami DOM.Ustaw true elementy są elementami DOM; w przeciwnym razie jest ustawiona na false.Jeśli elementType atrybut nie jest ustawiony i elementDomElement jest ustawiona true, IntelliSense traktuje każdy element 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.Ustaw true do wskazania elementów w tablicy można ustawić wartość NULL; w przeciwnym razie jest ustawiona na false.Wartością domyślną jest false.Ten atrybut nie jest stosowany do dostarczenia informacji IntelliSense przez Visual Studio.helpKeyword
Opcjonalne.Słowo kluczowe Pomocy F1.locid
Opcjonalne.Identyfikator lokalizacja informacji o zmiennej.Identyfikator jest albo członkiem lub identyfikator odpowiada name wartość w wiązce wiadomości definiowane przez metadane OpenAjax atrybutu.Typ identyfikatora zależy od formatu określonego w <loc> (JavaScript) tag.description
Opcjonalne.Opis zmiennej.
Przykład
Poniższy przykład kodu pokazuje, jak używać <var> element.
/// <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;
}
}