This documentation is archived and is not being maintained.
<summary> (JavaScript)
Visual Studio 2012
Specifies the description for a function or method.
<summary locid="descriptionID">description</summary>
The elements used to annotate functions, which include <summary> (JavaScript), <param> (JavaScript), and <returns> (JavaScript), must be placed in the function body before any statements.
The following code shows how to use the <summary> element.
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; }
Show: