Como: Criar comentários da lista de tarefas

  • Artigo

O Lista de tarefas exibe os comentários que começam com o marcador de comentário para a linguagem de desenvolvimento em seu código. Próximo aos comentários, o Lista de tarefas também exibe um token de tarefa padrão, como TODO, HACK ou UNDONE, ou um comentário personalizado. O número de comentários que aparecem na Lista de tarefas podem mudar, dependendo do tipo de projeto que você está trabalhando. Com Visual Basic e C# Visual, o Lista de tarefas exibe todos os comentários na solução. Com projetos do Visual C++, o Lista de tarefas exibe somente os comentários que são encontrados no arquivo que está atualmente ativo no editor.

Lista de tarefas comentários podem ser usados para indicar uma variedade de trabalho a ser feito no local marcado, incluindo:

  • recursos a ser adicionado;

  • problemas para ser corrigido;

  • classes para implementar;

  • Inserir marcadores de código de tratamento de erros; e

  • lembretes de check-in do arquivo.

Como com os outros Lista de tarefas entradas, clique duas vezes qualquer entrada de comentário para exibir o arquivo indicado no O Editor de código e saltar para a linha do código marcada.

Para adicionar um comentário à lista de tarefas

  1. Abra um arquivo de código-fonte no Editor de código.

  2. Começar um comentário em uma linha de código que você deseja marcar com <marker> <token>, onde <marker> é o marcador de comentário de linguagem de desenvolvimento e <token> é o nome de um reconhecido Lista de tarefas comentário token, como TODO, HACK, ou UNDONE, ou um símbolo de comentário personalizado.

    ObservaçãoObservação

    Para adicionar programaticamente os tokens de tarefa, defina a DefaultCommentToken da TaskList.

  3. Conclua o comentário com o texto que descreva a tarefa. For example:

    // TODO Fix this function.

    - or -

    ' HACK Update this procedure.

  4. Sobre o Exibir menu, clique em Lista de tarefas.

    O Lista de tarefas é exibido.

  5. No categorias , clique em comentários.

    O comentários lista exibe o texto do comentário. Você pode clicar em qualquer Lista de tarefas comentário para ativar o arquivo no O Editor de código e saltar para a linha de código que a marca de comentário.

Para alterar um comentário ou removê-lo da lista de tarefas

  1. Abra o arquivo de código para edição no O Editor de código.

  2. Modificar ou excluir o comentário no seu código.

Para alterar a prioridade padrão de um comentário

  1. On the Tools menu, click Options.

  2. Expanda o ambiente pasta e clique Lista de tarefas.

  3. Na a lista de Token, selecione o token de comentário que você deseja alterar a prioridade padrão.

    ObservaçãoObservação

    É possível alterar a prioridade para o comentário do TODO.

  4. No prioridade drop-down list, selecione um tipo de prioridade diferente.

  5. Click OK.

Para criar um token de comentário personalizado

  1. On the Tools menu, click Options. Expanda o ambiente pasta e clique Lista de tarefas.

    O Caixa de diálogo Opções de lista, ambiente, tarefa é exibido.

  2. No tokens de comentário , digite um nome para seu token personalizado.

  3. Do prioridade lista, selecione Normal, baixo, ou alta.

  4. Clique em Adde em seguida, clique em OK.

    Para obter mais informações sobre como adicionar identificadores personalizados para o Lista de tokens, consulte Como: Criar Tokens de comentários personalizado.

Exemplo

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

O exemplo mostra que você pode colocar comentários TODO em qualquer lugar em um arquivo de código. Lista de tarefas comentários são melhor utilizados para indicar o que deve ser realizado em linhas específicas ou seções do seu código. Eles são menos apropriados para obter descrições mais longas de tarefas gerais de desenvolvimento.

Consulte também

Tarefas

Como: Indicador de código

Como: controle de <>Task\ Lista>

Referência

Lista de Tarefas (Visual Studio)

Fornecendo comentários de código XML

Janela de indicador

Outros recursos

Indicadores de configuração no código