<param> (JavaScript)
Gibt Dokumentationsinformationen für einen Parameter in einer Funktion oder Methode an.
<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>
Parameter
name
Erforderlich.Der Name des Parameters.type
Dies ist optional.Der Datentyp des Parameters.Der Typ sind zulässig:Eine ECMAScript-Sprache geben die Spezifikation ECMAScript 5, wie Number und Object ein.
Ein DOM-Objekt, wie HTMLElement, Window und Document.
Eine JavaScript-Konstruktorfunktion.
integer
Dies ist optional.Wenn typeNumber ist, gibt an, ob der Parameter eine ganze Zahl ist.Legen Sie auf true, anzugeben, dass der Parameter 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 der dokumentierte Parameter ein DOM-Element ist.Legen Sie auf true, anzugeben, dass der Parameter ein DOM-Element ist; Wird andernfalls zu false.Wenn das Attribut nicht type festgelegt ist und domElement zu true festgelegt wird, behandelt IntelliSense den dokumentierten Parameter als HTMLElement, wenn Anweisungsvervollständigung ausführt.mayBeNull
Dies ist optional.Gibt an, ob der dokumentierte Parameter festgelegt werden kann, um ungültig zu machen.Legen Sie auf true, anzugeben, dass der - Parameter 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.locid
Dies ist optional.Der Bezeichner für Lokalisierungsinformation über den Parameter.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 <loc> (JavaScript) im - Element angegeben ist.parameterArray
Dies ist optional.Gibt ob der dokumentierte Parameter kann im Funktionsaufruf wiederholt werden angezeigt, ähnlich wie die wiederholten Parametern unterstützt wurden in die String.format-Funktion.Legen Sie auf true, anzugeben, dass der Parameter wiederholt werden kann; Wird andernfalls zu false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.optional
Dies ist optional.Gibt an, ob der dokumentierte Parameter in der aufrufenden Funktion optional ist.Legen Sie auf true, anzugeben, dass der Parameter optional ist, Wird andernfalls zu false.value
Dies ist optional.Gibt Code an, der für IntelliSense anstelle des Funktionscodes ausgewertet werden sollte selbst.Sie können dieses Attribut verwenden sollen Typinformationen bereitstellen, wenn der Parametertyp nicht definiert ist.Beispielsweise können Sie value=’1’ verwenden, um den Parametertyp als Zahl zu behandeln.description
Dies ist optional.Eine Beschreibung des Parameters.
Hinweise
Das einzige erforderliche Attribut ist name.Alle anderen Attribute sind optional.
Die Elemente, die verwendet werden, um Funktionen, z <summary> (JavaScript) Anmerkungen hinzuzufügen, <param> (JavaScript) und <returns> (JavaScript), müssen in den Funktionsrumpf vor allen Anweisungen eingefügt werden.
Wenn mehrere <param>-Elemente gibt, die den gleichen Namen haben, wird eines der Elemente <param> verwendet und die redundanten Elemente werden ignoriert.Das Verhalten, das bestimmt, welches Element verwendet wird, ist nicht definiert.Wenn name einen nicht vorhandenen Parameter verweist, wird das - Element ignoriert.
Beispiel
Das folgende Codebeispiel zeigt, wie das <param>-Element verwendet.
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.
}