<summary> (JavaScript)
Bir işlev veya yöntem açıklamasını belirtir.
<summary locid="descriptionID">description</summary>
Parametreler
locid
İsteğe Bağlı.İşlev veya yöntem hakkında bilgi yerelleştirme için tanımlayıcı.Bir üye tanımlayıcısıdır kimliği veya karşılık gelen name OpenAjax meta veriler tarafından tanımlanan ileti paket değeri öznitelik.Belirtilen biçim tanımlayıcısı türü bağlıdır <loc> (JavaScript) öğesi.description
İsteğe Bağlı.İşlev veya yöntem açıklaması.
Notlar
Öğeleri dahil işlevler eklemek için kullanılan <summary> (JavaScript), <param> (JavaScript), ve <returns> (JavaScript), işlev gövdesinde bildirisinden önce yerleştirilmelidir.
Örnek
Aşağıdaki kod nasıl kullanılacağını gösterir <summary> öğesi.
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;
}