XML コード コメントは、概要に加えて関数のパラメーターや戻り値に関する情報を示すためにスクリプト関数に追加する JScript (JavaScript) のコメントです。 Visual Studio では、これらの説明テキストは、スクリプト関数を参照したときに IntelliSense で表示されます。
注意
XML コード コメントは、参照されるファイル、アセンブリ、およびサービスでのみ使用できます。
JScript 関数の XML コード コメントを作成するには
内部に summary、param、および returns の各要素を記述し、各要素の前に 3 つのスラッシュ (///) を挿入します。
注意
各要素は 1 行で記述する必要があります。
XML コード コメントでサポートされている 3 つの要素をすべて含む 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 コード コメントを含む関数の左かっこを入力すると、XML コード コメントで定義されている情報が IntelliSense によって表示されます。