Compartilhar via

Diretrizes para usar ferramentas de análise de código

  • Artigo

A lista a seguir fornece diversas diretrizes que ajudarão a selecionar e gerenciar avisos de análise de código.

Recomendável

  • Revisar categorias de aviso.

    Como as ferramentas de análise de código executam verificações abrangentes por defeitos de código, é útil ter uma compreensão básica dos diferentes avisos.Para obter mais informações sobre categorias de aviso, consulte Análise de código para avisos do código gerenciado ou Análise de Código para Avisos C/C ++.

  • Analisar código existente.

    Dependendo do tipo de projeto, recursos e requisitos escolha a abordagem que atenda melhor às suas necessidades.

    • Ativar todos os avisos.

      Ativar todos os avisos e rever a lista de avisos gerado pela ferramenta de análise para determinar os avisos que você deseja ativar.

    • Ativar um subconjunto de avisos.

      Reveja as categorias de avisos para decidir um subconjunto de avisos para usar no seu projeto e ativar somente estes avisos.

  • Analisar código em desenvolvimento.

    Como você não está lidando com código existente, é recomendável que você ative todos os avisos e analise o código para defeitos em desenvolvimento.É bem mais fácil para analisar e corrigir o código à medida que você o desenvolve.Não aguarde até o final do ciclo de desenvolvimento para analisar o código ou ativar os avisos.Isso pode colocar pressão desnecessária em membros da equipe e poderá colocar em perigo a segurança do código e sua estabilidade.

  • Controlar avisos.

    Após determinar os avisos para usar em seu projeto, controle-os usando recursos de controle de trabalho.Para obter mais informações, consulte Como: Adicionar novos itens de trabalho.

  • Corrigir avisos.

    Há várias maneiras que você pode corrigir um aviso:

    • Corrigir - conserte o código e teste-o antes do check-in.

    • Suprimir - você pode usar o atributo System.Diagnostics.CodeAnalysis.SuppressMessageAttribute no código gerenciado para suprimir um aviso causado por código em uma localidade específica.

    • Desativar - você pode usar as páginas de propriedades do projeto para desativar avisos para todo o código gerenciado.Para C / C++, você pode usar um arquivo de cabeçalho que lista todos os avisos.Use esse arquivo para ativar ou desativar avisos que não são necessários para o seu projeto.

    Depois que o aviso é consertado, altere seu status de aviso para erro.Isso ajuda a manter seu código limpo.

  • Especificar requisito check-in.

    Você pode definir a política de check-in do código para exigir análise código para ser executado como parte da política de check-in.Somente código que passa pela análise é permitido para o check-in.Isto o ajudará a certificar-se de que o código que está sendo verificado está limpo.Para obter mais informações sobre diretiva de check-in, consulte Políticas de Check-in de Análise de Código.