<summary> (JavaScript)
Especifica la descripción de una función o un método.
<summary locid="descriptionID">description
</summary>
Parámetros
locid
Opcional.Identificador de la información de localización sobre la función o el método.El identificador es un identificador de miembro o corresponde al valor del atributo name en un paquete de mensajes definido por los metadatos de OpenAjax.El tipo de identificador depende del formato especificado en el elemento <loc> (JavaScript).description
Opcional.Descripción de la función o el método.
Comentarios
Los elementos utilizados para anotar funciones, entre los que se incluyen <summary> (JavaScript), <param> (JavaScript) y <returns> (JavaScript), se deben colocar en el cuerpo de la función antes de cualquier instrucción.
Ejemplo
En el código siguiente se muestra cómo usar el elemento <summary>.
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when supplied a radius parameter.</summary>
/// <param name="radiusParam" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}