<param> (JavaScript)
Określa informacje o dokumentacji dla parametru w funkcji lub 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
Wymagane.Nazwa parametru.type
Opcjonalne.Typ danych parametru.Typ może być jedną z następujących czynności:Języka ECMAScript typ specyfikacji ECMAScript 5, takie jak Number i Object.
A DOM object, such as HTMLElement, Window, and Document.
Funkcja konstruktora kodu JavaScript.
integer
Opcjonalne.Jeśli type jest Number, określa, czy parametr jest liczbą całkowitą.Zestaw do true do wskazania, że parametr jest liczbą całkowitą; w przeciwnym razie, zestaw do false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.domElement
Opcjonalne.Ten atrybut jest niezalecane; type atrybut ma pierwszeństwo przed ten atrybut.Ten atrybut określa, czy parametr udokumentowane jest DOM element.Zestaw do true do określenia, że parametr jest DOM element; w przeciwnym razie, zestaw do false.Jeśli type atrybut nie jest ustawiona i domElement jest ustawiona true, IntelliSense traktuje parametr udokumentowane jako HTMLElement podczas wykonywania instrukcji.mayBeNull
Opcjonalne.Określa, czy parametr udokumentowane można ustawić na wartość null.Zestaw do true do wskazania, że parametr można ustawić na wartość null; w przeciwnym razie, zestaw do false.Wartością domyślną jest false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.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.Zestaw do true , aby wskazać, że elementy w tablicy liczb całkowitych; w przeciwnym razie, zestaw do false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.elementDomElement
Opcjonalne.Ten atrybut jest niezalecane; elementType atrybut ma pierwszeństwo przed ten atrybut.Jeśli type jest Array, ten atrybut określa, czy elementy w tablicy są elementy DOM.Zestaw do true do określenia, że elementy są elementy DOM; w przeciwnym razie, zestaw do false.Jeśli elementType atrybut nie jest ustawiona i elementDomElement jest ustawiona true, IntelliSense traktuje każdego elementu 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.Zestaw do true do wskazania, że elementy w tablicy można ustawić na wartość null; w przeciwnym razie, zestaw do false.Wartością domyślną jest false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.locid
Opcjonalne.Identyfikator lokalizacji informacji na temat parametru.Identyfikator jest element członkowski lub identyfikator odpowiada name wartość w pakiet komunikatu definiowane przez metadane OpenAjax atrybutu.Typ identyfikatora zależy od formatu określonego w <loc> (JavaScript) element.parameterArray
Opcjonalne.Określa, czy można powtórzyć udokumentowane parametr w wywołaniu funkcji, podobne do powtarzania obsługiwanego w String.format funkcji.Zestaw do true do wskazania, że parametr może być powtarzany; w przeciwnym razie, zestaw do false.Ten atrybut nie jest używany przez program Visual Studio informacyjnych IntelliSense.optional
Opcjonalne.Określa, czy udokumentowane parametr jest opcjonalny w funkcji wywołującej.Zestaw do true do wskazania, że parametr jest opcjonalny; w przeciwnym razie, zestaw do false.value
Opcjonalne.Określa kod, które powinny być oceniane do użytku przez IntelliSense zamiast kodu funkcji.Możesz użyć tego atrybutu jest podanie informacji typu typ parametru jest niezdefiniowany.Na przykład, można użyć value=’1’ w leczeniu typ parametru jako liczba.description
Opcjonalne.Opis parametru.
Uwagi
Tylko atrybut wymagany jest name.Wszystkie inne atrybuty są opcjonalne.
Elementy używane do opisywania funkcji, takich jak <summary> (JavaScript), <param> (JavaScript), i <returns> (JavaScript), muszą być umieszczone w treści funkcji przed wszelkich instrukcji.
Jeśli istnieje wiele <param> elementy, które mają taką samą nazwę, jeden z <param> elementów jest używany i zbędne elementy są ignorowane.Nie zdefiniowano zachowania, które określa, który element jest używany.Jeśli name odnosi się do nieistniejącej parametru, element jest ignorowany.
Przykład
Poniższy przykład kodu pokazuje, jak używać <param> element.
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.
}