CodeEvent.Comment 屬性

發行項
10/28/2012

取得或設定與這個程式碼事件項目關聯的標頭註解。

命名空間： EnvDTE80
組件： EnvDTE80 (在 EnvDTE80.dll 中)

語法

'宣告
Property Comment As String

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
字串，包含標頭註解或空字串 (若未提供註解)。

備註

擷取的文字並不包含任何註解語法。此文字是根據語言的註解樣式，從來源衍生而來。例如，在 C# 中，註解的分隔符號 (Delimiter) 是 //，但在 Visual Basic，它可以是所有格符號 (') 或是 Rem (即備註 Remark 的簡寫)。

設定好之後，Comment 屬性會嘗試使用行導向式語法取代分隔式語法，保持任何現有註解的樣式。在處理序中，它會決定註解是要與程式碼項目接觸或是要以空白行分隔，來保持行導向式語法前端的任何縮排。

注意事項
在特定類型的編輯之後，程式碼模型項目 (例如類別、結構、函式、屬性、委派等) 的值可能不具決定性，表示其值不一定維持相同。如需詳細資訊，請參閱使用程式碼模型探索程式碼 (Visual Basic) 的＜程式碼模型項目值可以變更＞一節。

範例

下列範例示範如何使用 Comment 屬性。

若要測試這個屬性：

將游標放在事件物件上開啟目標專案，並選取程式碼事件項目。
執行增益集。

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

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