Configuração

English | Português (Brasil)

ComplexityAnalysis.Analyzers usa duas camadas de configuração:

• opções complexity_analyzers.* controlam o comportamento do analyzer;
• dotnet_diagnostic.<RULE_ID>.severity controla a severidade dos diagnósticos Roslyn.

As opções de comportamento são lidas pelas APIs de analyzer config do Roslyn. O analyzer não faz parsing manual de arquivos .editorconfig. As opções podem ser globais ou específicas por arquivo; quando as duas existem, o valor específico do arquivo prevalece para aquela syntax tree.

Valores inválidos são tratados com segurança: não quebram o build nem geram falha do analyzer. O analyzer retorna ao valor padrão documentado para aquela opção.

Opções do analyzer

Opção	Tipo	Padrão	Valores permitidos	Finalidade
complexity_analyzers.interprocedural_analysis	Boolean	true	true, false	Habilita expansão de métodos-fonte suportados na mesma compilation.
complexity_analyzers.recursion_analysis	Boolean	true	true, false	Habilita extração de recursão direta suportada e resolução de recorrências.
complexity_analyzers.max_call_depth	Integer	5	0 até 16	Limita a profundidade de expansão de métodos-fonte.
complexity_analyzers.max_methods_per_root	Integer	32	0 até 128	Limita expansões não cacheadas de métodos-fonte por análise de método raiz.
complexity_analyzers.maximum_complexity	String	none	none, constant, log_n, n, n_log_n, n2, n3, exponential, factorial	Habilita BIG1006 quando uma estimativa conhecida e comparável excede esse threshold.
complexity_analyzers.maximum_cyclomatic_complexity	Integer	sem valor	Inteiro decimal positivo	Habilita BIG2001 quando a Cyclomatic Complexity de um executable member suportado excede esse threshold.
complexity_analyzers.cyclomatic_complexity_mode	String	standard	standard, modified_mccabe	Seleciona a contabilização de switch para Cyclomatic Complexity.
complexity_analyzers.maximum_nesting_depth	Integer	sem valor	Inteiro decimal não negativo	Habilita BIG2002 quando a Maximum Control-Flow Nesting Depth de um executable member suportado excede esse threshold.
complexity_analyzers.maximum_method_nloc	Integer	sem valor	Inteiro decimal não negativo	Habilita BIG2003 quando o NLOC de um executable member suportado excede esse threshold.
complexity_analyzers.maximum_statement_count	Integer	sem valor	Inteiro decimal não negativo	Habilita BIG2004 quando o statement count de um executable member suportado excede esse threshold.
complexity_analyzers.maximum_token_count	Integer	sem valor	Inteiro decimal não negativo	Habilita BIG2005 quando o token count de um executable member suportado excede esse threshold.
complexity_analyzers.maximum_parameters	Integer	sem valor	Inteiro decimal não negativo	Habilita BIG2006 quando o Parameter Count source-declared de um executable member suportado excede esse threshold.
complexity_analyzers.maximum_cognitive_complexity	Integer	sem valor	Inteiro decimal não negativo	Habilita BIG2007 quando a Cognitive Complexity de um executable member suportado excede esse threshold.

Valores booleanos ignoram diferenças entre maiúsculas e minúsculas depois da remoção de espaços nas extremidades. Valores inteiros devem ser números decimais não negativos, sem sinal, ponto decimal, separadores ou espaços internos. Valores de threshold são case-sensitive.

Valores fora dos limites públicos de budget retornam ao padrão: max_call_depth = 5 e max_methods_per_root = 32. Thresholds ciclomáticos, de nesting, NLOC, statement count, token count, Parameter Count e Cognitive Complexity inválidos retornam para sem valor configurado. Modos ciclomáticos inválidos retornam para standard.

Exemplo

[*.cs]

complexity_analyzers.interprocedural_analysis = true
complexity_analyzers.recursion_analysis = true
complexity_analyzers.max_call_depth = 5
complexity_analyzers.max_methods_per_root = 32
complexity_analyzers.maximum_complexity = n_log_n
complexity_analyzers.maximum_cyclomatic_complexity = 10
complexity_analyzers.cyclomatic_complexity_mode = standard
complexity_analyzers.maximum_nesting_depth = 3
complexity_analyzers.maximum_method_nloc = 40
complexity_analyzers.maximum_statement_count = 25
complexity_analyzers.maximum_token_count = 300
complexity_analyzers.maximum_parameters = 5
complexity_analyzers.maximum_cognitive_complexity = 15

dotnet_diagnostic.BIG1006.severity = warning
dotnet_diagnostic.BIG2001.severity = warning
dotnet_diagnostic.BIG2002.severity = warning
dotnet_diagnostic.BIG2003.severity = warning
dotnet_diagnostic.BIG2004.severity = warning
dotnet_diagnostic.BIG2005.severity = warning
dotnet_diagnostic.BIG2006.severity = warning
dotnet_diagnostic.BIG2007.severity = warning

Comportamento do threshold

complexity_analyzers.maximum_complexity é opt-in. O valor padrão none significa que BIG1006 não reporta.

BIG1006 reporta somente quando todos estes pontos são verdadeiros:

• a complexidade do método é conhecida;
• o threshold configurado não é none;
• a estimativa e o threshold são comparáveis pelo modelo atual do analyzer;
• a estimativa é maior que o threshold.

Complexidade Unknown não produz diagnóstico de threshold. Complexidade multivariada incomparável, como uma expressão sobre variáveis independentes, também pode não produzir diagnóstico. BIG1006 é um sinal prático de análise estática, não uma prova matemática universal.

Exemplos:

Estimativa real	Threshold	Resultado
O(n^2)	n_log_n	Reporta BIG1006.
O(n log n)	n_log_n	Não reporta.
O(n)	n_log_n	Não reporta.
Unknown	n	Não reporta.
Expressão multivariada incomparável	n2	Não reporta.

Comportamento de Cyclomatic Complexity

complexity_analyzers.maximum_cyclomatic_complexity é opt-in. Quando não está configurado ou é inválido, BIG2001 não reporta. Valores válidos são inteiros decimais positivos. Igualdade não reporta; apenas valor real estritamente maior gera diagnóstico.

Cyclomatic Complexity é complexidade estrutural de caminhos de controle, não complexidade algorítmica de tempo. Um membro pode ser O(n) e, ao mesmo tempo, ter Cyclomatic Complexity 12. BIG2001 não afeta BIG0001, BIG1006, análise interprocedural, análise de recursão nem maximum_complexity.

A convenção standard usa baseline 1 + decision points e conta constructs documentados como if, loops, catch, ?:, short-circuit &&/||, cases/arms de switch, arms discard com guarda em switch expression, guards when e patterns or. No modo modified_mccabe, cada switch statement ou switch expression contribui uma decisão para a família de switch em vez de uma por case/arm não default; guards e patterns or continuam sendo contados separadamente.

Exemplos:

Valor real	Threshold	Resultado
9	10	Não reporta.
10	10	Não reporta.
11	10	Reporta BIG2001.

Comportamento de Maximum Nesting Depth

complexity_analyzers.maximum_nesting_depth é opt-in. Quando não está configurado ou é inválido, BIG2002 não reporta. Valores válidos são inteiros decimais não negativos. Igualdade não reporta; apenas valor real estritamente maior gera diagnóstico.

Maximum Control-Flow Nesting Depth mede a estrutura de fluxo de controle mais profundamente aninhada dentro de um executable member. Código straight-line tem depth 0, um único if ou loop tem depth 1, e constructs realmente aninhados aumentam a profundidade. Branches irmãos não acumulam.

A convenção de nesting conta if, loops, statements switch, switch expressions, try e expressões condicionais ?: como um nível. else, else if, cases, arms de switch, catches, finally, cadeias booleanas, patterns, guards, blocos simples, initializers, lock, using, fixed, checked e unchecked não adicionam nível por si só. Local functions, lambdas e anonymous methods aninhados são analisados como executable members independentes em vez de inflarem o pai lexical.

Exemplos:

Valor real	Threshold	Resultado
2	3	Não reporta.
3	3	Não reporta.
4	3	Reporta BIG2002.

Comportamento das métricas de tamanho

Os thresholds de tamanho são opt-in e independentes:

• complexity_analyzers.maximum_method_nloc habilita BIG2003;
• complexity_analyzers.maximum_statement_count habilita BIG2004;
• complexity_analyzers.maximum_token_count habilita BIG2005.

Quando um threshold não está configurado ou é inválido, seu diagnóstico não reporta. Valores válidos são inteiros decimais não negativos. Igualdade não reporta; apenas valor real estritamente maior gera diagnóstico.

NLOC conta linhas de origem dentro do corpo executável que contêm pelo menos um token de código pertencente ao membro, excluindo linhas em branco, linhas somente com comentários, linhas somente com chaves e linhas somente com delimitadores. Linhas de declaração/header fora do corpo executável não participam. Em expression-bodied members, apenas a expressão participa.

Statement count conta statements C# estruturais no corpo executável. Blocos são containers, não statements contados. Expression-bodied members contam como um statement sintético de expressão. Local functions, lambdas e anonymous methods aninhados são medidos independentemente; a declaração de local function conta como um statement do pai, mas seu corpo não infla o pai.

Token count conta tokens sintáticos C# não ausentes pertencentes ao corpo executável, incluindo pontuação e delimitadores, mas excluindo trivia, espaços em branco e comentários. Em expression-bodied members, apenas tokens da expressão participam.

Exemplos:

Métrica	Valor real	Threshold	Resultado
NLOC	9	10	Não reporta.
NLOC	10	10	Não reporta.
NLOC	11	10	Reporta BIG2003.
Statement count	26	25	Reporta BIG2004.
Token count	301	300	Reporta BIG2005.

Comportamento de Parameter Count

complexity_analyzers.maximum_parameters é opt-in. Quando não está configurado ou é inválido, BIG2006 não reporta. Valores válidos são inteiros decimais não negativos. Igualdade não reporta; apenas valor real estritamente maior gera diagnóstico.

Parameter Count conta parâmetros source-declared em executable members suportados. O receiver this de extension methods conta porque é um parâmetro explícito na fonte. Parâmetros opcionais/defaulted, params, ref, in e out contam uma vez cada.

Type parameters genéricos, constraints genéricas, variáveis capturadas, this implícito de instância, parâmetros gerados pelo compilador e value implícito de accessors não contam. Accessors de indexer suportados contam os parâmetros explícitos do indexer e continuam excluindo o value implícito de setter/init. Primary constructors permanecem deferred pela matriz atual de executable member.

Exemplos:

Valor real	Threshold	Resultado
4	5	Não reporta.
5	5	Não reporta.
6	5	Reporta BIG2006.
1	0	Reporta BIG2006.

Comportamento de Cognitive Complexity

complexity_analyzers.maximum_cognitive_complexity é opt-in. Quando não está configurado ou é inválido, BIG2007 não reporta. Valores válidos são inteiros decimais não negativos. Igualdade não reporta; apenas valor real estritamente maior gera diagnóstico.

Cognitive Complexity usa a convenção C# documentada deste projeto. Código straight-line começa em 0. Quebras estruturais de fluxo de controle adicionam 1 + nesting atual; else adiciona 1; sequências lógicas booleanas e de pattern adicionam custo de sequência/mudança; recursão direta a si mesmo adiciona um ponto uma vez por membro quando comprovada por identidade de símbolo; e break, continue e goto adicionam um ponto cada. Local functions, lambdas e anonymous methods aninhados são pontuados independentemente.

Veja Convenção de Cognitive Complexity para a tabela completa de score e exemplos passo a passo.

Exemplos:

Valor real	Threshold	Resultado
14	15	Não reporta.
15	15	Não reporta.
16	15	Reporta BIG2007.
1	0	Reporta BIG2007.

Feature flags

complexity_analyzers.interprocedural_analysis = false impede expansão para callees fonte suportados. A análise intraprocedural e a análise de operações BCL/LINQ suportadas permanecem ativas.

complexity_analyzers.recursion_analysis = false impede extração e resolução de recorrências de recursão direta, incluindo BIG1005. Análise intraprocedural não recursiva e expansão de métodos-fonte não recursivos ainda podem executar quando a análise interprocedural está habilitada.

Budgets de análise

O analyzer é limitado por opções públicas e hard limits:

• profundidade de chamada padrão: 5;
• profundidade máxima configurável: 16;
• métodos-fonte por raiz padrão: 32;
• máximo configurável de métodos-fonte por raiz: 128.

Ao atingir uma fronteira de budget, as chamadas afetadas permanecem conservadoras, normalmente Unknown. Um budget pequeno pode ser útil em smoke tests ou para consumidores mais cautelosos, mas pode reduzir a cobertura de BIG0001, BIG1004 e BIG1006 em código com muitas chamadas a métodos-fonte.

Severidade dos diagnósticos

Use o formato padrão do Roslyn por regra:

dotnet_diagnostic.<RULE_ID>.severity = <severity>

Valores comuns incluem:

none
silent
suggestion
warning
error
default

O compilador e o SDK determinam o comportamento exato do build para cada severidade.

Valores padrão dos diagnósticos

ID	Severidade padrão	Habilitado por padrão
BIG0001	Info	false
BIG1001	Info	true
BIG1002	Info	true
BIG1003	Info	true
BIG1004	Info	true
BIG1005	Info	true
BIG1006	Info	true
BIG2001	Info	true
BIG2002	Info	true
BIG2003	Info	true
BIG2004	Info	true
BIG2005	Info	true
BIG2006	Info	true
BIG2007	Info	true
BIG9000	Info	false

BIG1006 é habilitado por padrão como descriptor, mas permanece funcionalmente inativo até que complexity_analyzers.maximum_complexity seja configurado com um threshold concreto.

BIG2001 é habilitado por padrão como descriptor, mas permanece funcionalmente inativo até que complexity_analyzers.maximum_cyclomatic_complexity seja configurado com um threshold concreto.

BIG2002 é habilitado por padrão como descriptor, mas permanece funcionalmente inativo até que complexity_analyzers.maximum_nesting_depth seja configurado com um threshold concreto.

BIG2003, BIG2004 e BIG2005 são habilitados por padrão como descriptors, mas cada um permanece funcionalmente inativo até que seu threshold de tamanho correspondente seja configurado.

BIG2006 é habilitado por padrão como descriptor, mas permanece funcionalmente inativo até que complexity_analyzers.maximum_parameters seja configurado.

BIG2007 é habilitado por padrão como descriptor, mas permanece funcionalmente inativo até que complexity_analyzers.maximum_cognitive_complexity seja configurado.

Não há opção pública de threshold Halstead. As métricas Halstead são atualmente uma capacidade interna para reporting/tooling futuros, e nenhum valor Halstead derivado único foi adotado como threshold de manutenibilidade sustentado por evidência.

Configurações comuns

Habilite estimativas por método:

[*.cs]

dotnet_diagnostic.BIG0001.severity = suggestion

Promova diagnósticos acionáveis e checks de threshold:

[*.cs]

dotnet_diagnostic.BIG1001.severity = warning
dotnet_diagnostic.BIG1002.severity = warning
dotnet_diagnostic.BIG1003.severity = warning
dotnet_diagnostic.BIG1004.severity = warning
dotnet_diagnostic.BIG1005.severity = warning
complexity_analyzers.maximum_complexity = n_log_n
dotnet_diagnostic.BIG1006.severity = warning
complexity_analyzers.maximum_cyclomatic_complexity = 10
complexity_analyzers.cyclomatic_complexity_mode = modified_mccabe
dotnet_diagnostic.BIG2001.severity = warning
complexity_analyzers.maximum_nesting_depth = 3
dotnet_diagnostic.BIG2002.severity = warning
complexity_analyzers.maximum_method_nloc = 40
dotnet_diagnostic.BIG2003.severity = warning
complexity_analyzers.maximum_statement_count = 25
dotnet_diagnostic.BIG2004.severity = warning
complexity_analyzers.maximum_token_count = 300
dotnet_diagnostic.BIG2005.severity = warning
complexity_analyzers.maximum_parameters = 5
dotnet_diagnostic.BIG2006.severity = warning
complexity_analyzers.maximum_cognitive_complexity = 15
dotnet_diagnostic.BIG2007.severity = warning

Comprove temporariamente que o pacote carregou:

[*.cs]

dotnet_diagnostic.BIG9000.severity = warning

Mantenha o probe de infraestrutura desabilitado em projetos normais:

[*.cs]

dotnet_diagnostic.BIG9000.severity = none

O que não é configurável

O analyzer não expõe opções para mappings customizados de operações, regras customizadas de decision points ciclomáticos além do modo de switch documentado, convenções customizadas para métricas de tamanho, convenções customizadas de Parameter Count, convenções customizadas de Cognitive Complexity, classificação Halstead customizada ou thresholds Halstead, comportamento dos mappings BCL/LINQ, seleção de famílias de recorrência, tolerâncias de teoremas, análise de solution inteira, code fixes, complexidade de memória, complexidade paralela ou complexidade probabilística.

Operações não suportadas ou não resolvidas permanecem Unknown; não existe opção para convertê-las em uma classe de complexidade conhecida.