如何:创建 JScript XML 代码注释
XML 代码注释是添加到脚本函数的 JScript (JavaScript) 注释,用于提供摘要以及有关函数的参数和返回值的信息。 在 Visual Studio 中,当引用脚本函数时,将通过 IntelliSense 显示这些文本说明。
提示
XML 代码注释只能从引用的文件、程序集和服务中提供。
为 JScript 函数创建 XML 代码注释
内部包括 summary、param 和 returns 元素,每个元素前面有三个斜杠 (///)。
提示
这些元素必须位于单独一行。
下面的示例显示包括 XML 代码注释所支持的三个元素中的每个元素的 JScript 函数。
<script type="text/javascript"> function areaFunction(radiusParam) { /// <summary>Determines the area of a circle based on 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; } </script>
使用 IntelliSense 查看 XML 代码注释
键入使用 XML 代码注释标记的函数名称和左括号,如以下示例如示:
var areaVal = areaFunction(
当键入包含 XML 代码注释的函数的左括号时,编辑器会使用 IntelliSense 显示 XML 代码注释中定义的信息。