Cómo: Crear comentarios de lista de tareas

Actualización: noviembre 2007

La Lista de tareas muestra comentarios en el código que comienza con un marcador de comentario para el lenguaje de desarrollo. Junto a los comentarios, la Lista de tareas también muestra un símbolo (token) de tarea predeterminado, como TODO, HACK o UNDONE o un token de comentarios personalizado. El número de comentarios que aparecen en la Lista de tareas puede variar en función del tipo de proyecto en el que esté trabajando. En proyectos de Visual Basic y Visual C#, la Lista de tareas muestra todos los comentarios de la solución. En los proyectos de Visual C++, la Lista de tareas muestra sólo los comentarios que se encuentran en el archivo activo en el editor.

Los comentarios de la Lista de tareas se utilizan para indicar el trabajo que queda por hacer en la ubicación marcada, incluido lo siguiente:

• Características que se van a agregar

• Problemas que se van a corregir

• Clases que se van a implementar

• Ubicación de marcadores para el código de control de errores

• Avisos para proteger el archivo

Como en otras entradas de la Lista de tareas, se puede hacer doble clic en una entrada de comentario para mostrar el archivo indicado en el Editor de código y saltar a la línea de código marcada.

Para agregar un comentario a la Lista de tareas

1. Abra un archivo de código fuente en el Editor de código.

2. Comience un comentario en la línea de código que desee marcar con <marcador><token>, donde <marcador> es el marcador de comentario del lenguaje de programación utilizado y <token> es el nombre de un símbolo (token) de comentario de la Lista de tareas reconocido, como TODO, HACK o UNDONE, o un símbolo (token) de comentario personalizado.

   Nota:
   Para agregar símbolos (token) de tareas mediante programación, configure la propiedad DefaultCommentToken del objeto TaskList.

3. Finalice el comentario con texto que describa la tarea. Por ejemplo:

   // TODO Fix this function.
   

   O bien

   ' HACK Update this procedure.
   

4. En el menú Ver, haga clic en Lista de tareas.

   Se muestra la Lista de tareas.

5. En la lista Categorías, haga clic en Comentarios.

   La lista Comentarios muestra el texto de comentario. Puede hacer clic en cualquier comentario de la Lista de tareas para activar el archivo en el Editor de código y saltar a la línea de código que marca el comentario.

Para cambiar un comentario o quitarlo de la Lista de tareas

1. Abra el documento de código en el Editor de código.

2. Modifique o elimine el comentario del código.

Para cambiar la prioridad predeterminada de un comentario

1. En el menú Herramientas, haga clic en Opciones.

2. Expanda la carpeta Entorno y, a continuación, haga clic en Lista de tareas.

3. En la Lista de símbolos, seleccione el símbolo (token) de comentario cuya prioridad predeterminada desea modificar.

   Nota:
   No se puede cambiar la prioridad del comentario TODO.

4. En la lista desplegable Prioridad, seleccione otro tipo de prioridad.

5. Haga clic en Aceptar.

Para crear un símbolo de comentario personalizado

1. En el menú Herramientas, haga clic en Opciones. Expanda la carpeta Entorno y, a continuación, haga clic en Lista de tareas.

   Se mostrará Lista de tareas, Entorno, Opciones (Cuadro de diálogo).

2. En el cuadro Símbolo de comentario, escriba un Nombre para el símbolo (token) personalizado.

3. En la lista Prioridad, seleccione Normal, Baja o Alta.

4. Haga clic en Agregar y, a continuación, en Aceptar.

   Para obtener más información sobre cómo agregar símbolos (token) personalizados a la Lista de símbolos, vea Cómo: Crear símbolos de comentario personalizados.

Ejemplo

// 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.

El ejemplo muestra que puede colocar comentarios TODO en cualquier parte de un archivo de código. Los comentarios de la Lista de tareas son útiles para indicar el trabajo que se debe hacer en líneas o secciones concretas del código. No son tan adecuados para descripciones extensas de tareas de programación generales.

Vea también

Tareas

Cómo: Marcar código

Cómo: Controlar la lista de tareas

Referencia

Lista de tareas (Visual Studio)

Proporcionar comentarios del código XML

Marcador (Ventana)

Otros recursos

Establecer marcadores en el código