TaskList.DefaultCommentToken 属性

  • 项目

获取用于向**“任务列表”**窗口中添加任务的默认字符串。

命名空间：  EnvDTE
程序集：  EnvDTE（在 EnvDTE.dll 中）

语法

声明
ReadOnly Property DefaultCommentToken As String
    Get

string DefaultCommentToken { get; }

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

abstract DefaultCommentToken : string

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

.NET Framework 安全性

请参见

参考

TaskList 接口

EnvDTE 命名空间