Compartilhar via


Como: Criar comentários tarefa lista

The tarefa Lista exibe comentários que começam com o marcador de comentário para a sua linguagem de desenvolvimento em seu código.Próximo a comentários, a Lista de tarefas também exibe um token de tarefa padrão, sistema autônomo TODO, ataques de hackers ou UNDONE, ou um símbolo de comentário personalizado.O número de comentários que aparecem no tarefa Lista podem mudar, dependendo do tipo de projeto que você está trabalhando.Com o Visual Basic e Visual translation from VPE for Csharp, o Lista de tarefas exibe todos os comentários na solução.Com projetos do Visual C++, a tarefa Lista exibe somente os comentários que são encontrados no arquivo ativo no momento no editor.

tarefa Lista comentários podem ser usados para indicar uma variedade de trabalho a ser concluído no local marcado, incluindo:

  • recursos a serem adicionados

  • problemas para ser corrigido

  • classes para implementar;

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

  • lembretes de fazer check-in do arquivo.

sistema autônomo ocorre com outros tarefa Lista entradas, você pode clicar duas vezes em qualquer entrada de comentário para exibir o arquivo indicado no Editor de código e saltar para a linha do código marcadas.

Para adicionar um comentário à lista de tarefa

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

  2. Começar um comentário em uma linha de código que deseja marcar com <marker><token>, onde <marker>é o marcador de comentário para a sua linguagem de desenvolvimento e <token>é o nome de um reconhecidotarefa Lista comentário token, sistema autônomo, por exemplo, TODO, HACK, ou UNDONE, ou um símbolo de comentário personalizado.

    Observação:

    Para adicionar tarefa tokens programaticamente, defina o DefaultCommentToken da TaskList.

  3. Conclua o comentário com o texto que descreva a tarefa.Por exemplo:

    // TODO Fix this function.
    

    - ou -

    ' HACK Update this procedure.
    
  4. Sobre o Modo de exibição menu, clicar tarefa Lista.

    The tarefa Lista é exibida.

  5. No Categorias lista, click Comentários.

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

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

  1. Abra o arquivo de código para edição no 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. No menu Tools, clique em Options.

  2. expandir o Ambiente pasta e, em seguida, clicar tarefa Lista.

  3. In Lista de tokens, selecionar o símbolo de comentário que deseja alterar a prioridade padrão de.

    Observação:

    Não é possível alterar a prioridade para o comentário a fazer.

  4. No Prioridade drop-down, selecionar um tipo de prioridade diferente.

  5. Clique em OK.

Para criar um token de comentário personalizado

  1. No menu Tools, clique em Options.expandir o Ambiente pasta e, em seguida, clicar tarefa Lista.

    The Caixa de diálogo Opções de lista, o ambiente, tarefa é exibida.

  2. No Tokens de comentário caixa, digite um Nome seu token personalizado.

  3. From a Prioridade lista, selecionar Normal, Baixo, or Alta.

  4. clicar Adicionare, em seguida, clicar OK.

    Para obter mais informações sobre como adicionar identificadores personalizados à Lista de token, see Como: Criar tokens de comentário 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 a fazer comentários em qualquer lugar em um arquivo de código.Lista de tarefas comentários são melhor utilizados para indicar o trabalho que deve ser concluído em linhas específicas ou seções do seu código.Eles são menos apropriados para mais longas descrições de tarefas Geral de desenvolvimento.

Consulte também

Tarefas

Como: Código do indicador

Como: Controlar a lista de tarefas

Referência

Lista de Tarefas (Visual Studio)

Fornecer comentários de código XML

Janela indicador

Outros recursos

Marcadores de configuração no código