Uma regra é uma instrução específica que descreve uma ação a ser seguida ao gravar o código. Por exemplo, as seguintes instruções são regras de revisão de código:
As regras formam a base de uma configuração de análise. Ao executar uma análise, verifique se os recursos estão de acordo com uma regra específica, ou um conjunto de regras. É possível modificar as regras e criar regras definidas pelo usuário se você precisar que sejam mais específicas aos padrões de design do aplicativo. As regras listadas anteriormente, por exemplo, pertencem à categoria de princípios de design. As regras que se aplicam a recursos semelhantes, ou estruturas de código, pertencem à mesma categoria. É possível aplicar regras de diversas categorias dependendo do objetivo da revisão.
Os autores de regras designam um nível de gravidade a cada regra para especificar o quanto um recurso que está em conflito com a regra não cumpre os padrões. Cada regra possui um dos seguintes níveis de gravidade na tabela a seguir:
Ícone | Nível de gravidade | Descrição |
---|---|---|
![]() |
Recommendation | Esse é o menor nível de gravidade. O resultado indica um problema que não é sério, mas que deve que deve ser corrigido em breve. |
![]() |
Aviso | Este nível de gravidade indica que um recurso muito provavelmente tem um problema que deve ser resolvido. |
![]() |
É provável que ocorra | Esse é o nível de gravidade mais elevado. Indica que você deve resolver o problema para o qual o resultado aponta. |
Embora a recomendação seja o menor nível, também é importante tratar resultados com este nível de gravidade. Mesmo que esses resultados não sejam problemas imediatos, elas podem levar a problemas no futuro. As regras são baseadas em um conjunto de boas práticas e de padrões de mercado aos quais as equipes de engenharia devem aderir.
Provedores de análise são componentes da estrutura de análise que implementam grupos de ferramentas contendo categorias. Você pode selecionar diferentes provedores para diferentes tipos de análise e, dependendo dos requisitos da análise, é possível ativar ou desativar uma categoria de regra e regras individuais da categoria.
Um exemplo de uma categoria de regra é a categoria do desempenho para revisões de código. O desempenho, como um aspecto importante da qualidade geral de um aplicativo, deve ser uma das características testadas em uma revisão de código. A categoria de regra do desempenho tem três subcategorias: memória, perfil e velocidade, cada uma contendo um conjunto de regras aplicadas ao código-fonte ao executar uma análise com esta categoria selecionada.