Comment : créer des commentaires de la liste des tâches

  • Article

Mise à jour : novembre 2007

La liste des tâches affiche les commentaires de votre code qui commencent par le marqueur de commentaire de votre langage de développement. En regard des commentaires, la liste des tâches affiche également un jeton de tâche par défaut, tel que TODO, HACK ou UNDONE ou bien un jeton de commentaire personnalisé. Le nombre de commentaires affichés dans cette liste des tâches varie selon le type de projet sur lequel vous travaillez. Dans Visual Basic et Visual C#, tous les commentaires de la solution sont répertoriés dans la liste des tâches. Avec les projets Visual C++, elle affiche uniquement les commentaires disponibles dans le fichier actif dans l'éditeur.

Les commentaires de la Liste des tâches peuvent être utilisés pour indiquer divers travaux à effectuer à l'emplacement marqué, y compris :

  • les fonctionnalités à ajouter ;

  • les problèmes à corriger ;

  • les classes à implémenter ;

  • les marqueurs d'emplacement pour le code de gestion des erreurs ; et

  • les rappels à contrôler dans le fichier.

Comme avec les autres entrées de la Liste des tâches, vous pouvez double-cliquer sur une entrée de commentaire pour afficher le fichier indiqué dans l'éditeur de code et accéder à la ligne de code marquée.

Pour ajouter un commentaire à la liste des tâches

  1. Ouvrez un fichier de code source dans l'éditeur de code.

  2. Commencez un commentaire sur une ligne de code que vous souhaitez marquer avec <marqueur><jeton>, où <marqueur> désigne le marqueur de commentaire pour votre langage de développement et <jeton> le nom d'un jeton de commentaire de la Liste des tâches reconnu, comme TODO, HACK ou UNDONE, ou un jeton de commentaire personnalisé.

    Remarque :

    Pour ajouter des jetons de tâche par programme, définissez la propriété DefaultCommentToken de l'objet TaskList.

  3. Complétez le commentaire avec un texte décrivant la tâche. Par exemple :

    // TODO Fix this function.

    – ou –

    ' HACK Update this procedure.

  4. Dans le menu Affichage, cliquez sur Liste des tâches.

    La Liste des tâches s'affiche.

  5. Dans la liste Catégories, cliquez sur Commentaires.

    La liste Commentaires affiche le texte des commentaires. Vous pouvez cliquer sur un commentaire de la Liste des tâches pour activer le fichier dans l'éditeur de code et accéder à la ligne de code correspondante.

Pour modifier un commentaire ou le supprimer de la Liste des tâches

  1. Ouvrez votre fichier de code à modifier dans l'éditeur de code.

  2. Modifiez ou supprimez le commentaire dans votre code.

Pour modifier la priorité par défaut d'un commentaire

  1. Dans le menu Outils, cliquez sur Options.

  2. Développez le dossier Environnement, puis cliquez sur Liste des tâches.

  3. Dans la Liste des jetons, sélectionnez le jeton de commentaire dont vous souhaitez modifier la priorité par défaut.

    Remarque :

    Vous ne pouvez pas modifier la priorité pour le commentaire TODO.

  4. Dans la liste déroulante Priorité, sélectionnez un autre type de priorité.

  5. Cliquez sur OK.

Pour créer un jeton de commentaire personnalisé

  1. Dans le menu Outils, cliquez sur Options. Développez le dossier Environnement, puis cliquez sur Liste des tâches.

    La Liste des tâches, Environnement, boîte de dialogue Options s'affiche.

  2. Dans la zone Jetons des commentaires, tapez le Nom que vous souhaitez donner à votre jeton personnalisé.

  3. Dans la liste Priorité, sélectionnez Normale, Basse ou Haute.

  4. Cliquez sur Ajouter, puis sur OK.

    Pour plus d'informations sur l'ajout de jetons personnalisés à la liste des jetons, consultez Comment : créer des jetons de commentaire personnalisés.

Exemple

// The following C# code file contains several TODO reminders. 
// Note that each line task reminder begins, like this comment, 
//    with the C# comment indicator, '//'.

// TODO: Add standard code header comment here.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Windows.Forms;
// TODO: Add references to specific resources here.

namespace TodoExample
{
partial class TodoExample : Form
   {
      public TodoExample()
         {
            InitializeComponent();
         }
   }
}
// TODO: It is even possible to add comments at the end.

L'exemple montre que vous pouvez insérer des commentaires TODO où vous le souhaitez dans un fichier de code. Les commentaires de la liste des tâches sont principalement utilisés pour indiquer le travail à effectuer sur des lignes ou des sections spécifiques de votre code. Ils sont moins adaptés aux descriptions plus longues des tâches de développement générales.

Voir aussi

Tâches

Comment : ajouter un signet à du code

Comment : contrôler la liste des tâches

Référence

Liste des tâches (Visual Studio)

Insertion de commentaires dans le code XML

Signets, fenêtre

Autres ressources

Définition de signets dans le code