<summary> (JavaScript)
Especifica la descripción de una función o método.
<summary locid="descriptionID">description</summary>
Parámetros
locid
Opcional.El identificador de localización información acerca de la función o método.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) elemento.description
Opcional.Una descripción de la función o método.
Comentarios
Los elementos utilizados para realizar anotaciones en funciones, que incluyen <summary> (JavaScript), <param> (JavaScript), y <returns> (JavaScript), se debe colocar en el cuerpo de la función antes de cualquier instrucción.
Ejemplo
El código siguiente muestra cómo utilizar el <summary> elemento.
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when supplied 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;
}