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) にタスクを追加できます。 コード内でトークン名を解説として入力することにより、タスクが自動的に作成され、[タスク一覧] ウィンドウに追加されます。

トークンの最初の文字は、コメント行の最初の英数字であることが必要です。 トークンの後には、空白文字または英数字以外の文字が少なくとも 1 文字必要です。

たとえば、次のような行を追加します。

   'HACK: Need to optimize this loop. (このループを最適化する必要があります。)

"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 名前空間