방법: JScript XML 코드 주석 만들기

XML 코드 주석은 스크립트 함수의 매개 변수 및 반환 값에 대한 요약 및 정보를 제공하기 위해 사용자가 함수에 추가하는 JScript(JavaScript) 주석입니다. Visual Studio에서 이러한 텍스트 설명은 스크립트 함수를 참조할 때 IntelliSense를 통해 표시됩니다.

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 코드 주석에서 정의되는 정보가 편집기에 표시됩니다.

참고 항목

작업

연습: JScript IntelliSense

개념

JScript IntelliSense 개요