Demonstra Passo a passo: Configurando e usando uma regra personalizada definida

Artigo
08/08/2011

Esta explicação passo a passo mostra como usar as ferramentas de análise de código que foram configuradas para usar um personalizado conjunto de regras em uma biblioteca de classe. Você pode selecionar um conjunto de regras que se relaciona com o tipo de projeto que você especificou para sua solução, ou você pode selecionar a regra alternativa define para atender a uma necessidade específica, como verificação de código herdado para problemas que podem ser corrigidos de forma não-separável. Em ambos os casos, os conjuntos de regras também podem ser personalizados para ajustá-las às suas necessidades de projeto.

Esta explicação passo a passo, você irá percorrer esses processos:

Crie uma biblioteca de classe.
Selecione o Regras de diretrizes de Design básico do Microsoft conjunto de regras de análise de código.
Adicione seu próprio código à classe.
Execute análise de código.
Personalize o conjunto de regras.
Executar análise de código e ver como o conjunto de regras works de comportamento de personalização.

Pré-requisitos

Instalar Visual Studio Premium ou Visual Studio Ultimate.

Usando a regra conjuntos com a análise de código

Primeiro, crie uma biblioteca de classes simples.

Criar uma biblioteca de classe

Sobre o arquivo menu, clique em novo e, em seguida, clique em projeto.
No Novo projeto caixa de diálogo, em Tipos de projeto, clique em Visual C#.
Em Visual C#, selecione Biblioteca de classe.
No nome caixa de texto, digite RuleSetSample e clique em OK.

Em seguida, você selecionará o Regras de diretrizes de Design básico do Microsoft conjunto de regras e salvá-lo com seu projeto.

Selecione um conjunto de regras de análise de código

Sobre o Analyze menu, clique em Configurar a análise de código para RuleSetSample.

As configurações de análise de código aparecem.
No executa o conjunto de regras lista suspensa, selecione Todas as regras do Microsoft.

Para obter mais informações sobre os conjuntos de regras disponíveis, consulte Referência de conjunto de regras de análise de código para código gerenciado.

No menu Arquivo, clique em Salvar itens selecionados para atualizar o arquivo de projeto com informações sobre o conjunto de regras que você selecionou e suas configurações.

Dica

Em uma situação real, uma boa prática a ser usada para priorizar quais problemas você deseja destinar-se com a análise de código é iniciar com o As regras do mínimo recomendado conjunto de regras e corrigir os problemas desejados e, em seguida, adicionar incrementalmente mais regras ou regra define para localizar e corrigir os problemas adicionais.

Em seguida, você irá adicionar algum código para a biblioteca de classes que será usada para demonstrar a violações de CA1704 "Identificadores devem ser escritos corretamente" Regra de análise de código. Para obter mais informações, consulte CA1704: Identificadores devem ser escritos corretamente.

Adicionar seu próprio código.

No Solution Explorer, abra o arquivo Class1. cs e substitua o código existente com o seguinte:

using System;
using System.Collections.Generic;
using System.Text;

namespace RuleSetSample
{
    public class Class1
    {
        //The variable parameter names "a" and "b" will cause
        //the warning CA 1704 Microsoft.Naming "Consider 
        //providing a more meaningful name" to fire
        public int AddIntegers(int a, int b)
        {

            int sum = a + b;

            return (sum);
        }
    }
}

Agora você pode executar a análise de código no projeto RuleSetSample e procure os erros e avisos gerados na janela Error List.

Executar análise de código no projeto RuleSetSample

Sobre o Analyze menu, clique em Executar a análise de código em RuleSetSample.
Na janela Error List, clique em avisos e, em seguida, clique no Descrição cabeçalho de coluna para classificar os avisos de ordem alfanumérica.

Em um aplicativo do mundo real, você teria corrigir qualquer violação de regra que vale a pena corrigindo neste ponto, ou opcionalmente desativar ou suprimir uma regra, se você determinou que não era que vale a pena corrigindo. Para obter mais informações, consulte Suprimir Avisos, usando o atributo SuppressMessage.
Observe os avisos de CA1704. Essas violações nessa regra indicam que você deve" Considere fornecer um nome mais significativo para os parâmetros." Você pode corrigir o problema no seu código, ou você pode desativar a regra, conforme explicado no próximo procedimento.

Em seguida, você personalizará a regra definida para excluir o aviso de CA1704 " Identificadores devem ser escritas corretamente".

Personalizar a regra definida para o seu projeto desativar uma regra específica

Sobre o Analyze menu, clique em Configurar a análise de código para RuleSetSample.
No executa esse conjunto de regras drop-down lista, verifique o Todas as regras do Microsoft regra conjunto ainda está realçado e, em seguida, clique em Abrir. A página do conjunto de regra é exibida.
Expanda o nó de categoria de Microsoft.Naming e, em seguida, selecione o aviso de CA1704.
Sob o ação coluna, selecione Nenhum. Isso impede que CA1704 exibindo como um aviso ou erro na janela Error List.

Agora seria um bom momento para experimentar os vários botões da barra de ferramentas e opções para se familiarizar com eles de filtragem. Por exemplo, você pode usar o Group By na lista suspensa para ajudar na localização de uma regra específica ou a categoria de regras. Outro exemplo é que você pode usar o Ocultar as regras desativadas o botão da barra de ferramentas de páginas de conjunto de regra para ocultar ou mostrar todas as regras com o ação coluna definida como Nenhum. Isso pode ser útil se você quiser examinar quaisquer regras que desativado para verificar que você ainda deseja tê-los desativado.
No menu Exibir, clique na janela Propriedades. Tipo de My Custom Rule Set na caixa Nome das propriedades ferramenta janela. Isso altera o nome de exibição da nova regra definida Visual Studio IDE.
Sobre o arquivo menu, clique em Salvar todos os Rules.ruleset de Microsoft salvar sua regra personalizada definida. Navegue até a pasta raiz do seu projeto. Em o nome do arquivo caixa de texto, digite MyCustomRuleSet. O conjunto de regras personalizada pode ser selecionado para uso com o seu projeto.

Com o novo conjunto de regras criado, agora você precisa definir as configurações de projeto para especificar que você deseja usar a nova regra definida com ele.

Especifique o novo conjunto de regras para uso com seu projeto.

No Solution Explorer, clique com o botão direito no projeto e selecione Propriedades.
No Propriedades , clique em A análise de código.

No executa este conjunto de regras na lista suspensa, clique em < Browse..>. Navegue até a pasta raiz do seu projeto de código e selecione MyCustomRuleSet.ruleset. Este é um novo conjunto de regras que você criou no procedimento anterior.
Sobre o arquivo menu, clique em Salvar para salvar sua configuração de projeto. O conjunto de regras personalizadas agora pode ser usado com o seu projeto.

Finalmente, você executará novamente usando o conjunto de regras de MyCustomRuleSet de análise de código. Observe que a janela Error List não exibe a violação de regra de desempenho de CA1704.

Executar análise de código no projeto RuleSetSample pela segunda vez

Sobre o Analyze menu, clique em Executar a análise de código em RuleSetSample.
Na janela Error List, observe que, quando você clicar em avisos, você não vir mais as violações de aviso de CA1704 para o "Identificadores devem ser escritos corretamente" regra.

Consulte também

Tarefas

Como: Configurar análise de código para um projeto de código gerenciado

Referência

Referência de conjunto de regras de análise de código para código gerenciado

Compartilhar via