<param> (JavaScript)
Especifica la información de la documentación de un parámetro en una función o un método.
<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>
Parámetros
name
Requerido.Nombre del parámetro.type
Opcional.Tipo de datos del parámetro.El tipo puede ser:Un lenguaje ECMAScript escribe en la especificación de ECMAScript 5, como Number y Object.
Un objeto DOM, como HTMLElement, Window, y Document.
Una función constructora de JavaScript.
integer
Opcional.Si type es Number, especifica si el parámetro es un entero.Establezca en true para indicar que el parámetro es un entero; si no, establezca en false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.domElement
Opcional.Se deja de utilizar este atributo; el atributo type tiene prioridad sobre este atributo.Este atributo especifica si el parámetro documentado es un elemento DOM.Establezca en true para especificar que el parámetro es un elemento DOM; si no, establezca en false.Si el atributo type no se establece y domElement se establece en true, IntelliSense trata el parámetro documentado como HTMLElement al realizar la finalización de instrucciones.mayBeNull
Opcional.Especifica si el parámetro documentado se puede establecer en null.Establezca en true para indicar que se puede establecer en null; si no, establezca en false.El valor predeterminado es false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.elementType
Opcional.Si type es Array, este atributo especifica el tipo de los elementos de la matriz.elementInteger
Opcional.Si type es Array y elementType es Number, este atributo especifica si los elementos de la matriz son enteros.Establezca en true para indicar que los elementos de la matriz son enteros; si no, establezca en false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.elementDomElement
Opcional.Se deja de utilizar este atributo; el atributo elementType tiene prioridad sobre este atributo.Si type es Array, este atributo especifica si los elementos de la matriz son elementos DOM.Establezca en true para especificar que los elementos son elementos DOM; si no, establezca en false.Si el atributo elementType no se establece y elementDomElement se establece en true, IntelliSense trata cada elemento de la matriz como HTMLElement al realizar la finalización de instrucciones.elementMayBeNull
Opcional.Si type es Array, especifique si los elementos de la matriz se pueden establecer en null.Establezca en true para indicar que los elementos de la matriz se pueden establecer en null; si no, establezca en false.El valor predeterminado es false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.locid
Opcional.El identificador para la información de localización sobre el parámetro.El identificador es o un identificador de miembro o corresponde a name el valor de atributo en empaquetar un de mensaje definido por los metadatos de OpenAjax.El tipo de identificador depende del formato especificado en el elemento <loc> (JavaScript) .parameterArray
Opcional.Especifica si el parámetro documentado puede repetir en la llamada de función, similar a los parámetros extensibles compatibles en la función String.format .Establezca en true para indicar que el parámetro se puede repetir; si no, establezca en false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.optional
Opcional.Especifica si el parámetro documentado es opcional en la función de llamada.Establezca en true para indicar que el parámetro es opcional; si no, establezca en false.value
Opcional.Especifica el código que se debe evaluar para uso de IntelliSense en lugar del propio código de la función.Puede utilizar este atributo debe proporcionar información de tipos cuando el tipo de parámetro es indefinido.Por ejemplo, puede utilizar value=’1’ para tratar el tipo de parámetro como un número.description
Opcional.Una descripción del parámetro.
Comentarios
El único atributo necesario es name.El resto de los atributos son opcionales.
Los elementos utilizados para anotar funciones, como <summary> (JavaScript), <param> (JavaScript), y <returns> (JavaScript), se deben colocar en el cuerpo de la función antes de cualquier instrucción.
Si hay varios elementos <param> que tienen el mismo nombre, uno de los elementos <param> se utiliza y se omiten los elementos redundantes.El comportamiento que determina se utiliza el elemento no está definido.Si name hace referencia a un parámetro inexistente, se omite el elemento.
Ejemplo
El ejemplo de código siguiente muestra cómo utilizar el elemento <param> .
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.
}