TaskList.DefaultCommentToken 屬性

發行項
08/21/2008

更新：2007 年 11 月

取得預設的字串，將工作加入至 [工作清單] 視窗。

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

語法

ReadOnly Property DefaultCommentToken As String

Dim instance As TaskList
Dim value As String

value = instance.DefaultCommentToken

string DefaultCommentToken { get; }

property String^ DefaultCommentToken {
    String^ get ();
}

function get DefaultCommentToken () : String

屬性值

型別：System.String

預設的字串，用來將工作加入至 [工作清單] 視窗。

備註

您可以使用註解語彙基元將工作加入至 Visual Studio 整合式開發環境 (IDE)。輸入語彙基元名稱做為程式碼中的註解後，會自動建立工作並將工作加入至 [工作清單] 視窗。

語彙基元的第一個字元必須是在註解行的第一個英數字元。語彙基元後面必須為至少一個空白字元或非英數字元。

例如，加入以下這行：

'HACK: 需要將迴圈最佳化。

如果 "HACK" 是有效的語彙基元，會將字串加入至 [工作清單] 視窗做為新的工作項目。

由此屬性傳回的預設註解語彙基元是 "TODO"，且不能變更。

範例

Sub DefaultCommentTokenExample()
   ' Before running, add a task to the Task List.
   Dim win As Window = DTE.Windows.Item(Constants.vsWindowKindTaskList)
   Dim TL As TaskList = win.Object
   Dim TLItem As TaskItem = TL.TaskItems.Item(1)
   Dim msg As String

   ' List properties of the Task Item.
   msg = "TaskItem Category property value: " & TLItem.Category & vbCr
   msg = msg & "TaskItem SubCategory property value: " & TLItem.SubCategory & vbCr
   msg = msg & "TaskItem DefaultCommentToken property value: " & TL.DefaultCommentToken & vbCr
   msg = msg & "TaskItem Checked property value: " & TLItem.Checked & vbCr
   msg = msg & "TaskItem Displayed property value: " & TLItem.Displayed & vbCr
   msg = msg & "TaskItem IsSettable property value: " & TLItem.IsSettable(vsTaskListColumn.vsTaskListColumnCheck) & vbCr
   msg = msg & "TaskItem Priority property value: " & TLItem.Priority & vbCr
   MsgBox(msg)
End Sub