<summary> (JavaScript)

指定函数或方法的声明。

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

参数

  • locid
    可选。这个标示符是有关函数或方法的本地化信息。该标识符是成员编号或它对应于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)