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 de C/C++.

  • Analisar código existente.

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

    • Ativar todos os avisos.

      Habilitar todos os avisos e revise a lista de aviso é gerada pela ferramenta de análise para determinar os avisos que você deseja ativar.

    • Ativar um subconjunto de avisos.

      Revise as categorias de aviso para selecionar um subconjunto de avisos para usar em seu projeto e permitir que somente esses 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 espere até o final do ciclo de desenvolvimento para analisar o código ou para permitir que vários 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 habilitar os avisos usar em seu projeto, usando os recursos de rastreamento de trabalho para controlá-los. Para obter mais informações, consulte um dos seguintes tópicos:

    Como: Crie um Item de trabalho para um defeito do código gerenciado

    Como: Crie um Item de trabalho para defeitos de código C/C++

    Como: Criar um Item de trabalho de um defeito no código do Transact-SQL

  • Corrigir avisos.

    Você pode corrigir um aviso em uma das seguintes maneiras:

    • Corrigi: Corrigir o código e testá-lo antes de dar entrada.

    • Suprimir: -Use o atributo System.Diagnostics.CodeAnalysis.SuppressMessageAttribute no código gerenciado para suprimir o aviso de que é causado pelo código em um local específico.

    • Desative: Use as páginas de propriedades do projeto para desativar os 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 o código que passa a análise pode ser liberado. Isto o ajudará a certificar-se de que o código que está sendo verificado está limpo. Para obter mais informações sobre a diretiva de check-in, consulte Criando e usando as diretivas do Check-In de análise de código.