CodeEvent.DocComment 속성

아티클
08/09/2011

코드 이벤트 요소와 관련된 문서 주석을 가져오거나 설정합니다.

네임스페이스: EnvDTE80
어셈블리: EnvDTE80(EnvDTE80.dll)

구문

‘선언
Property DocComment As String
    Get
    Set

string DocComment { get; set; }

property String^ DocComment {
    String^ get ();
    void set (String^ value);
}

abstract DocComment : string with get, set

function get DocComment () : String
function set DocComment (value : String)

속성 값

형식: System.String
코드 이벤트 요소와 관련된 문서 주석이 들어 있는 문자열입니다. 주석이 제공되지 않은 경우에는 빈 문자열입니다.

설명

주석이 제공되지 않았거나 코드를 구현하는 언어에 문서 주석 메커니즘이 없는 경우 빈 문자열이 반환됩니다.

참고

클래스, 구조체, 함수, 특성, 대리자 등의 코드 모델 요소를 특정한 방식으로 편집한 후에는 요소의 값이 명확하지 않을 수 있습니다. 즉, 요소의 값이 항상 같다고 할 수 없습니다. 자세한 내용은 코드 모델을 사용하여 코드 검색(Visual Basic)의 "코드 모델 요소 값이 변경될 수 있음" 단원을 참조하십시오.

예제

다음 예제에서는 DocComment 속성의 사용 방법을 보여 줍니다.

이 속성을 테스트하려면

대상 프로젝트를 열고 이벤트 개체에 커서를 놓아 코드 이벤트 요소를 선택합니다.
추가 기능을 실행합니다.

public static void DocComment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nDocComment property: " +
                    codeEvent.DocComment, "Testing CodeEvent");
}