Menu Docs
Página inicial do Docs
/
Ferramentas
/
C# Analyzer
Página inicial do Docs
/
Ferramentas
/
C# Analyzer
Página inicial do Docs
/
Ferramentas
/
C# Analyzer

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:

  1. Instale o C# Analyzer conforme descrito no guia de instalação.

  2. 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.

  3. Adicione sua configuração ao seu arquivo mongodb.analyzer.json .

    A seguinte configuração de exemplo desabilita o rastreamento:

    { "EnableVariableTracking": "false" }

  4. 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

Se você não especificar um arquivo de configuração, o MongoDB Analyzer utilizará o valor padrão para todas as opções de configuração.

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
EnableVariableTracking
Type: boolean

Description: Specifies if the C# Analyzer tracks and composes builder expression variables.

Dica

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

Accepted Values: true or false
Default: true
LogFileName
Type: string

Description: Specifies the path to which the C# Analyzer writes its internal logs.

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>"
Accepted Values: A valid file path
Default: ""
LinqAnalysisVerbosity
Type: string

Description: Specifies which LINQ expressions the C# Analyzer analyzes. You can set this option to one of the following values:

  • "All": Analisar todas as expressões LINQ, exceto coleções e arrays do sistema

  • "Medium": Analisar todas as expressões LINQ, exceto coleções e arrays do sistema, em arquivos que incluem MongoDB.Driver e seus namespaces aninhados somente

  • "None": Não analise expressões LINQ

Importante

A opção de configuração do LinqAnalysisVerbosity está disponível somente no MongoDB Analyzer v2.0 e posterior.

Accepted Values: "All", "Medium", or "None"
Default: "Medium"
OutputDriverVersion
Type: boolean

Description: Specifies if the C# Analyzer includes your .NET/C# driver version in diagnostic messages.

Accepted Values: true or false
Default: false
OutputInternalExceptions
Type: boolean

Description: Specifies if the C# Analyzer includes internal exceptions in diagnostic messages.

Accepted Values: true or false
Default: false
OutputInternalLogsToFile
Type: boolean

Description: Specifies if the C# Analyzer writes its internal logs to a file.

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>"
Accepted Values: true or false
Default: false
PocoAnalysisVerbosity
Type: string

Description: Specifies which POCOs the C# Analyzer previews as JSON. You can set this option to one of the following values:

  • "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

Accepted Values: "All", "Medium", or "None"
Default: "Medium"
SendTelemetry
Type: boolean

Description: Specifies if the C# Analyzer collects and sends anonymized information to MongoDB Inc. to improve products.

Dica

Para saber mais sobre telemetria no MongoDB Analyzer, consulte a seção Telemetria deste guia.

Accepted Values: true or false
Default: 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 .

Para saber mais sobre como a MongoDB Inc. usa os dados coletados, consulte a Política de Privacidade.

Voltar

Regras e conteúdo da mensagem

Próximo

Problemas conhecidos

Nesta página