<summary> (JavaScript)

指定函数或方法的说明。

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

参数

  • locid
    可选。 本地化信息的函数或方法的标识符。 该标识符是任何一个成员 ID 或它对应于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)