CodeVariable.DocComment 屬性

取得或設定目前程式碼模型元素的文件註解。

命名空間： EnvDTE
組件： EnvDTE (在 EnvDTE.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)

型別：System.String
表示文件註解的字串。

如果在程式碼之中有特別的文件註解或屬性，DocComment 會將它傳回。如果實作程式碼模型的程式語言沒有文件註解機制，或者沒有與該程式碼項目關聯的註解，則 DocComment 會傳回空字串。

注意事項
這個屬性對於 Visual Basic 原始程式碼的程式碼項目而言是唯讀性質。另外像是類別、建構、函式、屬性 (Attribute)、委派 (Delegate) 等這些程式碼模型元素的值，在經過特定方式的編輯之後也可以為非決定性，即表示這些值將不再固定。如需詳細資訊，請參閱使用程式碼模型探索程式碼 (Visual Basic) 的＜程式碼模型項目值可以變更＞一節。