<var> (JavaScript)
Bir değişken için belge bilgilerini belirtir.
<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>
Parametreler
type
İsteğe Bağlı. Değişkenin veri türü. Tür, aşağıdakilerden biri olabilir:5 ECMAScript belirtimi, aþaðýdaki gibi bir ECMAScript dil türüne Number ve Object.
A DOM object, such as HTMLElement, Window, and Document.
JavaScript yapıcı işlevi.
integer
İsteğe Bağlı. type Olan Number, değişken bir tamsayı olup olmadığını belirtir. Ayarlamak true ; bir tamsayı değişken olduğunu belirtmek için Aksi takdirde set false. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.domElement
İsteğe Bağlı. Bu özniteliği önerilmiyor; type özniteliği üzerinde bu özniteliğe göre önceliklidir. Bu öznitelik belgelenen değişken dom öğesi olup olmadığını belirtir. Ayarlamak true değişken dom öğesi; olduğunu belirtmek için Aksi takdirde set false. type Özniteliğinin ayarlanmadığından ve domElement ayarlamak true, IntelliSense belgelenen değişken nitelendirir bir HTMLElement deyimi tamamlama işlemi yaparken.mayBeNull
İsteğe Bağlı. Belgelenen değişken ayarlanıp ayarlanamadığını belirtir null. Ayarlamak true değişkeni ayarlanabilir belirtmek için null; Aksi takdirde set false. false varsayılan değerdir. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.elementType
İsteğe Bağlı. type Olan Array, bu öznitelik Dizideki öğelerin türünü belirtir.elementInteger
İsteğe Bağlı. type Olan Array ve elementType olan Number, bu öznitelik, dizideki öğelerin tamsayılar olup olmadığını belirtir. Ayarlamak true Dizideki öğelerin tamsayı; olduğunu belirtmek için Aksi takdirde set false. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.elementDomElement
İsteğe Bağlı. Bu özniteliği önerilmiyor; elementType özniteliği üzerinde bu özniteliğe göre önceliklidir. type Olan Array, bu öznitelik, dizideki öğelerin dom öğeler olup olmadığını belirtir. Ayarlamak true öğeleri dom öğeleri; olduğunu belirtmek için Aksi takdirde set false. elementType Özniteliğinin ayarlanmadığından ve elementDomElement ayarlamak true, IntelliSense her bir öğesi olarak değerlendirir bir HTMLElement deyimi tamamlama işlemi yaparken.elementMayBeNull
İsteğe Bağlı. type Olan Array, dizideki öğelerin ayarlanıp ayarlanamadığını belirtir null. Ayarlamak true dizideki öğeler kümesi belirtmek için null; Aksi takdirde set false. false varsayılan değerdir. Bu öznitelik, IntelliSense bilgi sağlamak için Visual Studio tarafından kullanılmaz.helpKeyword
İsteğe Bağlı. F1 Yardım için anahtar sözcük.locid
İsteğe Bağlı. Değişken yerelleştirme öğrenmek için tanımlayıcı. Bir üye tanımlayıcısıdır kimliği veya karşılık gelen name özniteliği değerini OpenAjax meta veriler tarafından tanımlanan ileti paketteki. Belirtilen biçim tanımlayıcısı türü bağlıdır <loc> (JavaScript) etiket.description
İsteğe Bağlı. Değişken açıklaması.
Örnek
Aşağıdaki kod örneği nasıl kullanılacağını gösteren <var> öğesi.
/// <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;
}
}