<param> (JavaScript)
Určuje informace v dokumentaci pro parametr funkce nebo metody.
<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>
Parametry
name
Povinné.Název parametru.type
Nepovinné.Typ dat parametru.Typ může být jeden z následujících:Zadejte jazyka ECMAScript specifikace ECMAScript 5 jako Number a Object.
A DOM object, such as HTMLElement, Window, and Document.
Funkce konstruktoru jazyka JavaScript.
integer
Nepovinné.Pokud type je Number, určuje, zda je parametr typu integer.Nastavte true k označení, že parametr je celé číslo; v opačném případě nastavte false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.domElement
Nepovinné.Tento atribut je zastaralý; type atribut přednost tento atribut.Tento atribut určuje, zda je parametr dokumentované element modelu DOM.Nastavte true určit, že parametr je element modelu DOM; v opačném případě nastavte false.Pokud type atribut není nastaven a domElement je nastavena na true, IntelliSense dokumentované parametr zachází jako HTMLElement při dokončování.mayBeNull
Nepovinné.Určuje, zda zdokumentované parametr lze nastavit na hodnotu null.Nastavte true k označení, že parametr lze nastavit na hodnotu null; v opačném případě nastavte false.Výchozí hodnota je false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.elementType
Nepovinné.Pokud type je Array, tento atribut určuje typ prvků v poli.elementInteger
Nepovinné.Pokud type je Array a elementType je Number, tento atribut určuje, zda jsou prvky pole celých čísel.Nastavte true označuje, že jsou prvky pole celých čísel; v opačném případě nastavte false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.elementDomElement
Nepovinné.Tento atribut je zastaralý; elementType atribut přednost tento atribut.Pokud type je Array, tento atribut určuje, zda jsou prvky pole, elementy modelu DOM.Nastavte true že prvky jsou prvky modelu DOM; v opačném případě nastavte false.Pokud elementType není nastaven atribut a elementDomElement je nastavena na true, technologie IntelliSense zpracovává každý prvek v poli jako HTMLElement při dokončování.elementMayBeNull
Nepovinné.Pokud type je Array, určuje, zda lze prvky pole nastavit na hodnotu null.Nastavte true označující, že prvky pole, můžete nastavit na hodnotu null; v opačném případě nastavte false.Výchozí hodnota je false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.locid
Nepovinné.Identifikátor pro lokalizaci informace o parametru.Buď člen je identifikátor ID nebo odpovídá name v balíku zpráv definované metadaty OpenAjax hodnotu atributu.Identifikátor typu závisí na formátu zadaném v <loc> (JavaScript) prvku.parameterArray
Nepovinné.Určuje, zda lze opakovat dokumentované parametr ve volání funkce podobné parametry, které jsou podporovány v opakující se String.format funkce.Nastavte true k označení, že parametr můžete opakovat; v opačném případě nastavte false.Tento atribut není použit v aplikaci Visual Studio informace technologie IntelliSense.optional
Nepovinné.Určuje, zda zdokumentované parametr je volitelný ve volání funkce.Nastavte true označuje, že parametr je volitelný; v opačném případě nastavte false.value
Nepovinné.Určuje kód, který by měl být vyhodnocen použít technologii IntelliSense místo samotného kódu funkce.Můžete je poskytnout informace o typu typ parametru je nedefinovaný atribut.Například můžete použít value=’1’ typ parametru zachází jako číslo.description
Nepovinné.Popis parametru.
Poznámky
Je vyžadován atribut pouze name.Všechny atributy jsou nepovinné.
Prvky použité opatřit funkce, <summary> (JavaScript), <param> (JavaScript), a <returns> (JavaScript), musí být umístěn v těle funkce před všechny příkazy.
Pokud existuje více <param> prvky, které mají stejný název jednoho z <param> prvky použity a přebytečné prvky jsou ignorovány.Chování, které určuje, který prvek je použito není definována.Pokud name odkazuje na neexistující parametr prvek ignorován.
Příklad
Následující příklad kódu ukazuje, jak použít <param> prvku.
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.
}