共用方式為


<summary> (JavaScript)

指定函式或方法的描述。

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

參數

  • locid
    選擇項。 如需有關的函式或方法的當地語系化資訊識別項。 識別項是成員,不論是哪一識別碼,或相對於name屬性在訊息集結 OpenAjax 中繼資料所定義的值。 識別項型別中指定的格式而定<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="radius" 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)