Visual C++ 설명서 태그에 대한 구분 기호

설명서 태그를 사용하려면 설명서 주석이 시작되고 끝나는 컴파일러를 나타내는 구분 기호가 필요합니다.

XML 문서 태그에 다음과 같은 종류의 구분 기호를 사용할 수 있습니다.

구분 기호	설명
///	설명서 예제에 표시되고 Visual Studio C++ 프로젝트 템플릿에서 사용하는 양식입니다.
/** */	여러 줄 구분 기호입니다.

/** */ 구분 기호를 사용할 때 몇 가지 서식 규칙이 있습니다.

• 구분 기호가 포함된 /** 줄의 경우 나머지 줄이 공백이면 주석에 대해 줄이 처리되지 않습니다. 첫 번째 문자가 공백인 경우 해당 공백 문자는 무시되고 나머지 줄은 처리됩니다. 그러지 않으면 /** 구분 기호 다음 줄의 전체 텍스트가 주석의 일부로 처리됩니다.

• 구분 기호가 포함된 */ 줄의 경우 구분 기호까지 */ 공백만 있는 경우 해당 줄은 무시됩니다. 그러지 않으면 줄의 텍스트가 */ 구분 기호까지 주석의 일부로 처리되며, 다음 글머리 기호에서 설명하는 패턴 일치 규칙을 따릅니다.

• 구분 기호로 /** 시작하는 줄 뒤에 있는 줄의 경우 컴파일러는 선택적 공백과 별표(*)로 구성된 각 줄의 시작 부분에서 공통 패턴을 찾은 다음 더 많은 선택적 공백을 찾습니다. 컴파일러가 각 줄의 시작 부분에서 공통 문자 집합을 찾으면, */ 구분 기호가 있는 줄까지 포함하여 /** 구분 기호 뒤의 모든 줄의 패턴을 무시합니다.

예제

• 다음 주석에서 유일하게 처리되는 부분은 <summary>로 시작하는 줄입니다. 다음 두 태그 형식은 동일한 주석을 생성합니다.

  /**
  <summary>text</summary>
  */
  /** <summary>text</summary> */
  

• 컴파일러는 " * " 패턴을 적용하여 두 번째 및 세 번째 줄의 시작 부분에서 무시합니다.

  /**
   * <summary>
   *  text </summary>*/
  

• 컴파일러는 두 번째 줄에 별표가 없으므로 이 주석에서 패턴을 찾을 수 없습니다. 두 번째 줄과 세 번째 줄 */의 모든 텍스트는 주석의 일부로 처리됩니다.

  /**
   * <summary>
     text </summary>*/
  

• 컴파일러는 두 가지 이유로 이 주석에서 패턴을 찾을 수 없습니다. 첫째, 별표 앞에 일관된 수의 공백으로 시작하는 줄이 없습니다. 둘째, 다섯 번째 줄이 공백과 일치하지 않는 탭으로 시작합니다. 주석의 일부로 처리될 때까지 */ 두 번째 줄의 모든 텍스트입니다.

  /**
    * <summary>
    * text
   *  text2
     *  </summary>
  */
  

참고 항목

XML 설명서