다음을 통해 공유


<summary>(JavaScript)

메서드 또는 함수에 대 한 설명을 지정 합니다.

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

매개 변수

  • locid
    선택 사항입니다.함수나 메서드에 대 한 지역화 정보에 대 한 식별자입니다.두 멤버 식별자입니다 ID 또는 해당는 name 특성 값 OpenAjax 메타 데이터에 의해 정의 된 메시지 번들에서.식별자 형식에 따라 달라 집니다에 지정 된 형식에는 <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="radius" 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)