CodeEvent.DocComment 屬性

發行項
05/16/2015

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

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

語法

'宣告
Property DocComment As String

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)

屬性值

類型：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");
}