TaskList.DefaultCommentToken, propriété

Article
05/16/2015

Obtient la chaîne par défaut pour l'ajout de tâches à la fenêtre Liste des tâches.

Espace de noms : EnvDTE
Assembly : EnvDTE (dans EnvDTE.dll)

Syntaxe

'Déclaration
ReadOnly Property DefaultCommentToken As String

string DefaultCommentToken { get; }

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

abstract DefaultCommentToken : string with get

function get DefaultCommentToken () : String

Valeur de propriété

Type : String
Chaîne par défaut pour l'ajout de tâches à la fenêtre Liste des tâches.

Notes

Vous pouvez utiliser les jetons de commentaires pour ajouter des tâches à votre environnement de développement intégré (IDE) Visual Studio. En entrant le nom du jeton en tant que remarque dans votre code, une tâche est automatiquement créée et ajoutée à la fenêtre Liste des tâches.

Le premier caractère d'un jeton doit être le premier caractère alphanumérique de la ligne de commentaire. Le jeton doit être suivi par au moins un espace blanc ou un caractère autre qu'un espace blanc.

Par exemple, vous pouvez ajouter cette ligne :

'HACK: Besoin d'optimiser cette boucle.

Si « HACK » est un jeton valide, la chaîne est ajoutée à la fenêtre Liste des tâches en tant que nouvel élément de tâche.

Le mot clé de commentaire par défaut, retourné par cette propriété, est « TODO » et ne peut pas être modifié.

Exemples

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

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

TaskList Interface

EnvDTE, espace de noms

Partager via