CodeClass2.Comment 속성

아티클
08/09/2011

코드 클래스와 관련된 주석을 설정하거나 가져옵니다.

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

구문

‘선언
Property Comment As String
    Get
    Set

string Comment { get; set; }

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

abstract Comment : string with get, set

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

속성 값

형식: System.String
주석을 나타내는 문자열입니다.

구현

CodeClass.Comment

설명

Comment는 클래스의 헤더 주석을 설정하거나 반환합니다. 반환된 텍스트에는 주석 구문이 포함되어 있지 않습니다. 텍스트는 언어의 주석 스타일에 따라 소스에서 추출됩니다. 예를 들어, C#에서 주석 구분 기호는 //이지만, Visual Basic의 경우 주석 구분 기호는 아포스트로피(') 또는 Rem(remark의 줄임말)입니다.

Comment를 설정하면 줄로 구분되는 구문 및 줄이 아닌 구분 기호로 구분되는 구문을 사용하여 기존 주석의 스타일이 유지됩니다. 프로세스에서 주석이 코드 요소와 만나는지 또는 빈 줄로 구분되는지 확인하여 줄로 구분되는 구문에 앞서 모든 들여쓰기를 유지합니다.

참고

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

예제

[C#]

public void CodeClass2CommentExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point within a class definition.
    try
    {   // Get the CodeClass2 at the insertion point.
        TextSelection sel = 
        (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Set the header comment for the CodeClass.
        cls.Comment = "Comment added programmatically.";
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}