<signature> (JavaScript)
Agrupa un conjunto de elementos relacionados de una función o método para proporcionar documentación para las funciones sobrecargadas.
<signature externalid="id" externalFile="filename" helpKeyword="keyword" locid="descriptionID" ></signature>
Parámetros
externalid
Opcional.Si el format de atributo para el <loc> (JavaScript) es el elemento vsdoc, este atributo especifica el miembro ID se utiliza para localizar el código XML que está asociado con la firma.A diferencia de la locid atributo, este atributo especifica que se deben cargar todos los elementos en el miembro que tiene esta ID.Cualquier información de descripción asociado está presente en el código XML también se combinarán con los elementos especificados en la firma.Esto le permite especificar elementos adicionales, tales como <capability>, en el archivo sidecar sin especificar en el archivo de origen.externalides un atributo opcional.externalFile
Opcional.Especifica el nombre del archivo en el que se va a buscar el externalid.Este atributo se omite si no hay externalid está presente.Se trata de un atributo opcional.El valor predeterminado es el nombre del archivo actual pero con una extensión de archivo de XML en lugar de js.De forma predeterminada, las reglas de búsqueda de recursos administrados para la localización se utilizan para buscar el archivo.helpKeyword
Opcional.La palabra clave de Ayuda F1.locid
Opcional.Identificador de la información de localización sobre el campo.El identificador es miembro ID o corresponde a la name valor en un paquete de mensaje definido por los metadatos de OpenAjax de atributo.El tipo de identificador depende del formato especificado en el <loc> (JavaScript) etiqueta.
Comentarios
Utilizar una <signature> (elemento) para cada uno puede sobrecargar descripción de la función en el archivo .js o utilice uno <signature> (elemento) para cada ID de miembro externo especificado.
El <signature> se debe colocar el elemento en el cuerpo de la función antes de cualquier instrucción.Cuando se utiliza <summary> (JavaScript), <param> (JavaScript), o <returns> (JavaScript) elementos con el <signature> (elemento), coloque los otros elementos dentro de la <signature> bloque.
Ejemplo
En el ejemplo de código siguiente se muestra cómo utilizar el <signature> elemento.
// Use of <signature> with externalid.
// Requires use of the <loc> tag to identify the external functions.
function illuminate(light) {
/// <signature externalid='M:Windows.Devices.Light.Illuminate()' />
/// <signature externalid='M:Windows.Devices.Light.Illuminate(System.Int32)'>
/// <param name='light' type='Number' />
/// </signature>
}
// Use of <signature> for overloads implemented in JavaScript.
function add(a, b) {
/// <signature>
/// <summary>function summary 1</summary>
/// <param name="a" type="Number">The first number</param>
/// <param name="b" type="Number">The second number</param>
/// <returns type="Number" />
/// </signature>
/// <signature>
/// <summary>function summary 2 – differ by number of params</summary>
/// <param name="a" type="Number">Only 1 parameter</param>
/// <returns type="Number" />
/// </signature>
/// <signature>
/// <summary>function summary 3 – differ by parameter type</summary>
/// <param name="a" type="Number">Number parameter</param>
/// <param name="b" type="String">String parameter</param>
/// <returns type="Number" />
/// </signature>
/// <signature>
/// <summary>function summary 4 – differ by return type</summary>
/// <param name="a" type="Number">The first number</param>
/// <param name="b" type="Number">The second number</param>
/// <returns type="String" />
/// </signature>
return a + b;
}