<param> (JavaScript)
Bir işlev veya yöntem bir parametre için belge bilgileri belirtir.
<param name="parameterName" type="ParameterType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" parameterArray="true|false" optional="true|false" value="code">description</param>
Parametreler
name
Gerekli.Parametrenin adı.type
İsteğe Bağlı.Parametresinin veri türü.Tür, aşağıdakilerden biri olabilir:ECMAScript dil yazın 5 ECMAScript belirtimi gibi 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, parametre bir tamsayı olup olmadığını belirtir.Ayarlamak true parametresi bir tamsayı; olduğunu belirtmek için Aksi takdirde, set false.Bu öznitelik Visual Studio'nun IntelliSense bilgi sağlamak için kullanılmaz.domElement
İsteğe Bağlı.Bu öznitelik kullanım dışıdır; type özniteliği bu özniteliğe göre önceliklidir.Bu öznitelik belgelenen parametre dom öğesi olup olmadığını belirtir.Ayarlamak true parametresi dom öğesi; olduğunu belirtmek için Aksi takdirde, set false.type Özniteliğinin ayarlanmadığından ve domElement ayarlamak true, IntelliSense belgelenen parametre davranır bir HTMLElement deyimi tamamlama yaparken.mayBeNull
İsteğe Bağlı.Belgelenen parametresi ayarlanmış olup olmadığını belirtir null.Ayarlamak true parametre kümesi belirtmek için null; Aksi takdirde, set false.false varsayılan değerdir.Bu öznitelik Visual Studio'nun IntelliSense bilgi sağlamak için 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 Visual Studio'nun IntelliSense bilgi sağlamak için kullanılmaz.elementDomElement
İsteğe Bağlı.Bu öznitelik kullanım dışıdır; elementType özniteliği bu özniteliğe göre önceliklidir.type Olan Array, bu öznitelik, dizideki öğelerin dom öğeleri olup olmadığını belirtir.Ayarlamak true öğelerin dom öğeleri; olduğunu belirtmek için Aksi takdirde, set false.elementType Özniteliğinin ayarlanmadığından ve elementDomElement ayarlamak true, IntelliSense her öğenin bir dizi olarak davranır bir HTMLElement deyimi tamamlama 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 Visual Studio'nun IntelliSense bilgi sağlamak için kullanılmaz.locid
İsteğe Bağlı.Parametre bilgilerini yerelleştirme için tanımlayıcı.Bir üye tanımlayıcısıdır kimliği veya karşılık gelen name öznitelik değeri OpenAjax meta verileri tarafından tanımlanan ileti paket.Belirtilen biçimi tanımlayıcısı türü bağlıdır <loc> (JavaScript) öğesi.parameterArray
İsteğe Bağlı.Desteklenen parametreler yinelenen benzer işlev çağrısı içinde belgelenen parametre yinelenen olup olmadığını belirtir String.format işlev.Ayarlamak true parametresi yinelenebildiği; belirtmek için Aksi takdirde, set false.Bu öznitelik Visual Studio'nun IntelliSense bilgi sağlamak için kullanılmaz.optional
İsteğe Bağlı.Belgelenen parametresi arama işlevinde isteğe bağlı olup olmadığını belirtir.Ayarlamak true parametresi isteğe bağlıdır; olduğunu belirtmek için Aksi takdirde, set false.value
İsteğe Bağlı.İşlev kodu kendisini IntelliSense tarafından kullanılmak üzere değerlendirilmesi gerektiğini kodunu belirtir.Bunu kullanabilirsiniz özniteliğidir parametre türü tanımlanmamış olduğunda tür bilgileri sağlamak için.Örneğin, kullanabileceğiniz value=’1’ parametre türü sayı olarak değerlendirmek için.description
İsteğe Bağlı.Parametre açıklaması.
Notlar
Yalnızca gerekli bir özniteliktir name.Tüm öznitelikler isteğe bağlıdır.
İşlevler, aşağıdakiler gibi ek açıklama eklemek için kullanılan öğelerin <summary> (JavaScript), <param> (JavaScript), ve <returns> (JavaScript), işlev gövdesi bildirisinden önce yerleştirilmelidir.
Varsa birden çok <param> aynı adı, biri olan öğeler <param> öğeleri kullanılır ve gereksiz öğeler dikkate alınmaz.Hangi öğe belirler davranışı tanımlı değil.name Başvurduğu öğe varolmayan bir parametre yoksayılır.
Örnek
Aşağıdaki kod örneğinde nasıl kullanılacağını gösterir <param> öğesi.
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when provided a radius parameter.</summary>
/// <param name="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}
// Uses of <param> with the value attribute.
function calculate(a) {
/// <param name='a' value='1'/>
a. // Completion list for a Number.
}
function calculate(a) {
/// <param name='a' value='{x:0,y:0}'/>
a. // x and y appear in the completion list.
}