共用方式為


<summary> (JavaScript)

針對函式或方法指定描述。

<summary locid="descriptionID">description
</summary>

參數

  • locid
    選擇項。函式或方法的當地語系化資訊識別項。識別項是成員 ID,或其對應於 OpenAjax 中繼資料在訊息繫結所定義的 name 屬性值。識別項的型別取決於在 <loc> (JavaScript) 項目中指定的格式。

  • description
    選擇項。函式或方法的說明。

備註

在任何陳述式之前的函式主體,必須用於加註函式的項目,包括 <summary> (JavaScript)<param> (JavaScript)<returns> (JavaScript),。

範例

下列程式碼將示範如何使用 <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;
  }

請參閱

概念

XML 文件註解 (JavaScript)