Passo a passo: Configurando e usando uma regra personalizada definida

Artigo
02/25/2013

Essa explicação passo a passo mostra como usar as ferramentas de análise de código que foram configurados para usar um conjunto de regras personalizado em uma biblioteca de classes.Você pode selecionar um conjunto de regras que está relacionado ao tipo de projeto que você especificou para sua solução, ou você pode selecionar conjuntos alternativas de regras para atender a uma necessidade específica como o código herdado de mineração para os problemas que podem ser corrigidos de uma maneira que.Em ambos os casos, os conjuntos de regra também podem ser personalizados para ajustar-los aos requisitos de projeto.

Em essa explicação passo a passo, você irá com esses processos:

Crie uma biblioteca de classes.
Selecione o conjunto de regras de análise de código de Regras de diretriz de design básico da Microsoft .
Adicionar seu próprio código para a classe.
Executar a análise de código.
Personalizar o conjunto de regras.
Executar a análise de código e ver como o comportamento set de personalização da regra funciona.

Pré-requisitos

Visual Studio Ultimate, Visual Studio Premium, ou Visual Studio Professional

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

Primeiro, crie uma biblioteca de classe simples.

Crie uma biblioteca de classe

Em o menu de Arquivo , clique em Novo e clique em Projeto.
Em a caixa de diálogo de Novo Projeto , em tipos de projeto, clique em Visual C#.
Em Visual C#, Biblioteca de Classesselecione.
Em a caixa de texto de Nome , o tipo RuleSetSample e clique em OK.

Em seguida, você irá selecionar a regra de Regras de diretriz de design básico da Microsoft definida com e salvar ao seu projeto.

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

Em o menu de Analisar , clique Configurar a análise de código para RuleSetSample.

Os parâmetros de configuração para análise de código aparecem.

Em a lista suspensa de Executar este conjunto de regras , Microsoft todas as regrasselecione.

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

Em o menu, clique Salvar itens selecionados arquivo 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 do mundo real, uma boa prática usar priorizar problemas que você deseja utilizar com análise de código são começar com a regra de regras recomendadas mínimo definida e corrigir os problemas desejados, e então adiciona incremental mais regras ou a regra define para localizar e corrigir os problemas adicionais.

Em seguida, você adicionará alguns códigos para a biblioteca de classes que será usada para demonstrar violações de CA1704 “identificadores deve ser” regra grafado corretamente de análise de código.Para mais informações, consulte CA1704: Identificadores devem ser escritos corretamente.

Adicionar seu próprio código

Em o solution Explorer, abra o arquivo Class1.cs de 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 de RuleSetSample e procurar todos os erros e avisos gerados na janela de error list.

Análise de código em execução no projeto de RuleSetSample

Em o menu de Analisar , clique Executar a análise de código em RuleSetSample.
Em a janela de error list, clique em Avisos e clique no cabeçalho de Descrição para classificar alfanumèrica avisos.

Em um aplicativo real, você corrigiria qualquer valor de violações de regra correção em este ponto, ou opcionalmente desativar ou elimina uma regra se você determinar que não era corrigir de valor.Para mais informações, consulte Suprimir Avisos, usando o atributo SuppressMessage.
Observe os avisos CA1704.Essas violações em esta regra indicam que você deve “considere fornecer um nome mais significativo para os parâmetros.” Você pode corrigir o problema em seu código ou você pode desativar a regra, conforme explicado no procedimento a seguir.

Em seguida, você irá personalizar a regra definida para excluir o aviso CA1704, os identificadores “devem ser escritos corretamente”.

Personalizar a regra definida para seu projeto desativa uma regra específica

Em o menu de Analisar , clique Configurar a análise de código para RuleSetSample.
Em a lista suspensa de Executar este conjunto de regras , verifique se o conjunto de regras de Microsoft todas as regras é realçado ainda e clique em Abrir.A página ajustada de regra é exibida.
Expanda o nó de categoria de Microsoft.Naming, e selecione o aviso CA1704.
Em a coluna de Ação , selecione nenhum. Isso impede que CA1704 exibe como um aviso ou um erro na janela de error list.

Agora é bons tempo fazer experiências com vários botões da barra de ferramentas e opções de filtragem se familiarizar com eles.Por exemplo, você pode usar a lista suspensa de Agrupar por para ajudar a localizar uma regra específica, ou a categoria de regras.Um exemplo é que você pode usar o botão de Regras desativadas ocultar na barra de ferramentas ajustada de páginas de regras para ocultar ou exibir todas as regras à coluna de Ação definida como Nenhum.Isso pode ser útil se você desejar verificação de quaisquer regras que você desative para verificar que você ainda deseja ter as desativadas.
Em o menu de exibição, a janela propriedades de clique.O tipo My Custom Rule Set na caixa de ferramentas nome das propriedades utiliza a janela.Isso altera o nome para exibição da nova regra definida em Visual Studio IDE.
Em o menu de Arquivo , clique Salvar Microsoft qualquer Rules.ruleset para salvar o conjunto personalizado de regra.Navegue até a pasta raiz do seu projeto.Em a caixa de texto de o nome de arquivo , digite MyCustomRuleSet.O conjunto de regra personalizada agora pode ser selecionado para uso com seu projeto.

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

Especificar a nova regra definida para uso com seu projeto

Em o solution Explorer, clique com o botão direito do mouse no projeto e selecione Propriedades.
Em a guia de Propriedades , clique Análise de Código.

Em a lista suspensa de Executar este conjunto de regras , **<Browse..>**clique em.Navegue até a pasta raiz do seu projeto de código e selecione MyCustomRuleSet.ruleset.Esta é a nova regra definida que você criou no procedimento anterior.
Em o menu de Arquivo , clique Salvar para salvar sua configuração do projeto.O conjunto de regra personalizada agora pode ser usado com seu projeto.

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

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

Em o menu de Analisar , clique Executar a análise de código em RuleSetSample.
Em a janela de error list, observe que quando você clica em Avisos, você não vir o CA1704 que as violações de aviso para os identificadores “devem ser” regra grafado corretamente.

Compartilhar via