Ler em inglês

Compartilhar via


Análise de código

Você pode usar analisadores de código para localizar problemas potenciais no seu código de aplicativo do .NET Framework. Os analisadores encontram possíveis problemas e sugerem correções.

Os analisadores de código baseados em Roslyn são executados interativamente no Visual Studio enquanto você escreve seu código ou como parte de um build de CI. Você deve adicionar o analisador ao seu projeto tão cedo quando possível no ciclo de desenvolvimento. Quanto antes você encontrar potenciais problemas no seu código, mais fácil será corrigi-los. Os analisadores sinalizam problemas no código existente e avisam sobre novos problemas à medida que você continua o desenvolvimento.

Observação

Este artigo usa o pacote NuGet Microsoft.NetFramework.Analysisers agora preterido. A partir do .NET 5, os analisadores NET são incluídos no SDK do .NET. Se necessário, você poderá usar o pacote NuGet Microsoft.CodeAnalysis.NetAnalyzers. Para obter mais informações, confira Análise de código no .NET.

Instalar e configurar analisadores

O Analisador do .NET Framework é fornecido no pacote do NuGet Microsoft.NetFramework.Analyzers. Esse pacote fornece os analisadores específicos às APIs do .NET Framework, que inclui os analisadores de segurança. O pacote está incluído no pacote Microsoft.CodeAnalysis.FxCopAnalyzers, portanto, se você instalar esse pacote, não será necessário instalar os analisadores do .NET Framework separadamente.

Instale o pacote NuGet em cada projeto em que você deseja que os analisadores sejam executados. Somente um desenvolvedor precisa adicioná-los ao projeto. O pacote de analisador é uma dependência de projeto e será executado no computador de cada um dos desenvolvedores assim que ele tiver a solução atualizada.

Para instalar o pacote, clique com o botão direito do mouse no projeto e selecione "Gerenciar Dependências". No explorador do NuGet, pesquise "Microsoft. NetFramework.Analyzers". Instale a versão estável mais recente em todos os projetos na solução.

Usar os analisadores

Depois de instalar o pacote do NuGet, compile a solução. O analisador relatará eventuais problemas que ele localize na base de código. Os problemas são relatados como avisos na janela Lista de Erros do Visual Studio, conforme mostrado na imagem a seguir:

Issues reported by .NET Framework analyzers.

Ao escrever código, você vê linhas onduladas sob qualquer problema potencial existente nele. Passe o mouse sobre qualquer problema para obter mais informações e ver sugestões para qualquer possível correção, conforme mostrado na imagem a seguir:

Interactive report of issues found by code analyzers.

Para obter mais informações, confira Análise de código no Visual Studio.

Tipos de regras

Os analisadores examinam o código em sua solução e exibem avisos com um prefixo CA. Para obter uma lista de todos os avisos possíveis, confira Regras de qualidade de código. Apenas alguns desses avisos se aplicam a APIS do .NET Framework, incluindo:

Confira também