CodeClass2.Comment 屬性

發行項
08/12/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# 中，註解的分隔符號 (Delimiter) 是 //，但在 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);
    }
}