Share via


XML 코드 주석 제공

업데이트: 2007년 11월

코드 주석이란 소스 코드 파일에 있는 주석을 말합니다. IDE(통합 개발 환경)의 사용자는 IntelliSense 기능을 통해 이 주석을 사용할 수 있습니다.

[Visual Basic]

XML 코드 주석은 '''(작은따옴표 세 개) 구분 기호를 통해 Visual Basic에서 사용될 수 있습니다. 자세한 내용은 방법: Visual Basic에서 XML 문서 만들기를 참조하십시오.

[C#, J#]

XML 문서 기능을 사용하여 코드에 주석을 입력할 수 있습니다. XML 문서 주석을 사용하여 솔루션의 소스 파일에 정의된 형식과 멤버에 주석을 달 경우 해당 주석은 다음과 같이 IntelliSense 기능을 통해 표시됩니다.

참고:

부분 메서드(Partial Method)를 주석으로 처리할 경우 정의 위치가 아니라 구현 위치에 있는 주석만 IntelliSense 기능에 표시됩니다.

자세한 내용은 XML 문서 주석(C# 프로그래밍 가이드)을 참조하십시오.

[C++]

기본적으로 구분 기호를 사용하는 소스 코드의 주석은 멤버 목록에서 관련 멤버 옆에 표시됩니다. 자세한 내용은 C++ CommentsXML Documentation (C++)을 참조하십시오.

멤버 목록을 스크롤하면 IntelliSense는 강조 표시된 멤버 옆에 있는 팝업 창에 최대 12줄까지 주석을 표시합니다. 함수에 대한 주석이 두 개 이상 있는 경우 IntelliSense는 코드 내의 주석 위치에 따라 어느 주석을 멤버 목록에 표시할지 결정합니다.

  1. IntelliSense가 선언의 줄 끝 주석을 먼저 표시합니다. 예를 들면, 다음과 같습니다.

    void MyFunction();   //EOL declaration comments
    
  2. IntelliSense가 이전 주석 형식을 모두 찾지 못하는 경우 선언 바로 위에 나타나는 주석들을 빈 줄 없이 표시합니다. 예를 들면, 다음과 같습니다.

    //Before declaration comments
       void MyFunction();
    
  3. IntelliSense가 코드에서 두 개의 이전 주석 형식을 찾지 못하는 경우 정의의 줄 끝 주석을 표시합니다. 예를 들면, 다음과 같습니다.

    int CMyAppDoc::MyVariable=2; // EOL definition comments
    
  4. 마지막으로 코드에 이전 주석 형식이 나타나지 않는 경우 IntelliSense는 정의 바로 위에 나타나는 주석들을 빈 줄 없이 표시합니다. 예를 들면, 다음과 같습니다.

    //Before definition comments
    CMyAppDoc::MyFunction() 
    {
       return; 
    }
    

참고 항목

참조

멤버 목록

기타 리소스

IntelliSense 사용