Configurar o MongoDB C# Analyzer

Visão geral

Saiba como configurar o C# Analyzer em seu projeto .NET e quais opções de configuração estão disponíveis.

Configuração

Para configurar o C# Analyzer, execute as seguintes ações:

Instale o C# Analyzer conforme descrito no guia de instalação.
Crie um arquivo especificando sua configuração para o C# Analyzer denominado mongodb.analyzer.json.

Importante
Nomenclatura
Você deve nomear seu arquivo de configuração mongodb.analyzer.json.
Adicione sua configuração ao seu arquivo mongodb.analyzer.json .

The following sample configuration makes the C# Analyzer use the LINQ3 provider.
{ "DefaultLinqVersion": "V3" }
Adicione o seguinte ao arquivo .csproj para seu aplicativo .NET dentro da marcação Project :
<ItemGroup> <AdditionalFiles Include="<path to your mongodb.analyzer.json file>" /> </ItemGroup>

Observação

A configuração é opcional

If you do not specify a configuration file, the C# Analyzer uses the default value for all configuration options.

Para saber mais sobre arquivos de projeto .NET, consulte Noções básicas sobre o arquivo de projeto da Microsoft.

Para saber mais sobre a marcação AdditionalFiles, consulte Usando arquivos adicionais na documentação Roslyn.

Opções

A seguir está uma descrição de todas as opções de configuração suportadas pelo C# Analyzer:

Nome

Descrição

DefaultLinqVersion

Tipo: string

Descrição: O provedor LINQ que o C# Analyzer usa.

Dica

Para saber mais sobre LINQ, consulte a página Analise seu código .

Valores aceitos: "V2" ou "V3"
Padrão: "V2"

EnableVariableTratracking

Tipo: booleano

Descrição: Especifica se o C# Analyzer acompanha e compõe variáveis de expressão do construtor.

Dica

Para saber mais sobre expressões de construtor, consulte a página Analise seu Código .

Valores aceitos: true ou false
Padrão: true

Nome do arquivo de log

Tipo: string

Descrição: especifica o caminho para o qual o C# Analyzer grava seus log internos.

Importante

Para gerar registros, você deve especificar um arquivo de log e a opção OutputInternalLogsToFile .

Use a seguinte configuração de exemplo para tornar as informações de saída do C# Analyzer em um arquivo de log:

"OutputInternalLogsToFile": true,
"LogFileName": "<path to your logfile>"

Valores aceitos: um caminho de arquivo válido
Padrão: ""

OutputDriverVersion

Tipo: booleano

Descrição: especifica se o C# Analyzer inclui a versão do driver .NET/C# nas mensagens de diagnóstico.

Valores aceitos: true ou false
Padrão: false

OutputInternalExceptions

Tipo: booleano

Descrição: especifica se o C# Analyzer inclui exceções internas em mensagens de diagnóstico.

Valores aceitos: true ou false
Padrão: false

OutputInternalLogsToFile

Tipo: booleano

Descrição: especifica se o C# Analyzer grava seus logs internos em um arquivo.

Importante

Para gerar registros, você deve especificar um arquivo de log e a opção OutputInternalLogsToFile .

Use a seguinte configuração de exemplo para tornar as informações de saída do C# Analyzer em um arquivo de log:

"OutputInternalLogsToFile": true,
"LogFileName": "<path to your logfile>"

Valores aceitos: true ou false
Padrão: false

PocoAnalysisVerbosity

Tipo: string

Descrição: especifica quais POCOs o C# Analyzer visualiza como JSON. Você pode definir esta opção para um dos seguintes valores:

"All": Visualizar todos os POCOs
"Medium": Visualize apenas POCOs que fazem parte de uma expressão LINQ ou construtores ou têm atributos BSON
"None": Não visualize POCOs

Valores aceitos: "All", "Medium" ou "None"
Padrão: "Medium"

Enviar telemetria

Tipo: booleano

Descrição: especifica se o C# Analyzer coleta e envia informações anônimas para a MongoDB Inc. para melhorar os produtos.

Dica

To learn more about telemetry in the C# Analyzer, see the Telemetry section of this guide.

Valores aceitos: true ou false
Padrão: true

Para saber mais sobre as opções de configuração compatíveis com o MongoDB Analyzer, consulte o código-fonte do MongoDB C# Analyzer.

Telemetria

Quando o C# Analyzer analisa seu código-fonte, a ferramenta, por padrão, coleta e envia informações anônimas para a MongoDB Inc.

Para desativar esse recurso, especifique a seguinte opção em seu arquivo de configuração:

"SendTelemetry": false

Para exibir uma lista completa de todas as informações coletadas pelo C# Analyzer quando você tiver habilitado a telemetria, consulte a página de perguntas frequentes .

To learn more about how MongoDB Inc. uses collected data, see the Privacy Policy.

Voltar

Regras e conteúdo da mensagem

Problemas conhecidos