<var> (JavaScript)
Gibt Dokumentationsinformationen für eine Variable.
<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>
Parameter
type
Dies ist optional.Der Datentyp der Variablen.Der Typ sind zulässig:Ein ECMAScript-Sprachentyp, der in der Spezifikation ECMAScript 5, wie Number und Object ist.
Ein DOM-Objekt, wie HTMLElement, Window und Document.
Eine JavaScript-Konstruktorfunktion.
integer
Dies ist optional.Wenn typeNumber ist, gibt an, ob die Variable eine ganze Zahl ist.Legen Sie auf true, anzugeben, dass die Variable eine ganze Zahl ist, Wird andernfalls zu false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.domElement
Dies ist optional.Dieses Attribut ist veraltet; type das Attribut hat Vorrang vor diesem Attribut.Dieses Attribut gibt an, ob die dokumentierte Variable ein DOM-Element ist.Legen Sie auf true, anzugeben, dass die Variable ein DOM-Element ist; Wird andernfalls zu false.Wenn das Attribut nicht type festgelegt ist und domElement zu true festgelegt wird, behandelt IntelliSense die dokumentierte Variable als HTMLElement, wenn Anweisungsvervollständigung ausführt.mayBeNull
Dies ist optional.Gibt an, ob die dokumentierte Variablen festgelegt werden kann, um ungültig zu machen.Legen Sie auf true, anzugeben, dass die Variable festgelegt werden kann, um ungültig zu machen; Wird andernfalls zu false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.elementType
Dies ist optional.Wenn typeArray ist, gibt dieses Attribut den Typ der Elemente im Array an.elementInteger
Dies ist optional.Wenn typeArray ist und elementTypeNumber ist, gibt dieses Attribut an, ob die Elemente im Array ganze Zahlen sind.Legen Sie auf true, anzugeben, dass die Elemente im Array ganze Zahlen sind; Wird andernfalls zu false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.elementDomElement
Dies ist optional.Dieses Attribut ist veraltet; elementType das Attribut hat Vorrang vor diesem Attribut.Wenn typeArray ist, gibt dieses Attribut an, ob die Elemente im Array DOM-Elemente sind.Legen Sie auf true, anzugeben, dass die Elemente DOM-Elemente sind; Wird andernfalls zu false.Wenn das Attribut nicht elementType festgelegt ist und elementDomElement zu true festgelegt wird, behandelt IntelliSense jedes Element im Array als HTMLElement, wenn Anweisungsvervollständigung ausführt.elementMayBeNull
Dies ist optional.Wenn typeArray ist, gibt an, ob die Elemente im Array festgelegt werden können, um ungültig zu machen.Legen Sie auf true, anzugeben, dass die Elemente im Array festgelegt werden können, um ungültig zu machen; Wird andernfalls zu false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.helpKeyword
Dies ist optional.Das Schlüsselwort für F1-Hilfe.locid
Dies ist optional.Der Bezeichner für Lokalisierungsinformation über die Variable.Der Bezeichner ist entweder eine Member ID, oder sie entspricht dem name-Attributwert in einem Meldungsbündel, das von OpenAjax-Metadaten definiert ist.Der Bezeichnertyp hängt vom Format ab, das im <loc> (JavaScript)-Tag angegeben wird.description
Dies ist optional.Eine Beschreibung der Variablen.
Beispiel
Das folgende Codebeispiel zeigt, wie das <var>-Element verwendet.
/// <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;
}
}