Docs Menu
Docs Home
/ /

Configura el Analizador C# de MongoDB

Aprenda cómo configurar el analizador de C# en su proyecto .NET y qué opciones de configuración están disponibles.

Para configurar el analizador de C#, realice las siguientes acciones:

  1. Instale el analizador de C# como se describe en La guía de instalación.

  2. Cree un archivo que especifique su configuración para el analizador de C# llamado mongodb.analyzer.json.

    Importante

    Nombramiento

    Debes nombrar tu archivo de configuración mongodb.analyzer.json.

  3. Añade tu configuración a tu archivo mongodb.analyzer.json.

    La siguiente configuración de ejemplo deshabilita el seguimiento de variables:

    { "EnableVariableTracking": "false" }
  4. Agregue lo siguiente al archivo .csproj para su aplicación .NET dentro de la etiqueta Project:

    <ItemGroup>
    <AdditionalFiles Include="<path to your mongodb.analyzer.json file>" />
    </ItemGroup>

Nota

La configuración es opcional

Si no especifica un archivo de configuración, el analizador de C# utiliza el valor predeterminado para todos Opciones de configuración.

Para obtener más información sobre los archivos de proyecto .NET, consulte Descripción del archivo de proyecto de Microsoft.

Para obtener más información sobre la AdditionalFiles etiqueta, consulte Uso de archivos adicionales en la documentación de Roslyn.

A continuación se muestra una descripción de todas las opciones de configuración compatibles con C# Analyzer:

Nombre
Descripción
EnableVariableTracking
Type: boolean

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

Tip

Para obtener más información sobre las expresiones de construcción, consulte la página Analice su 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 generar registros, debe especificar un archivo de registro y la opción OutputInternalLogsToFile.

Utilice la siguiente configuración de ejemplo para generar información de salida del analizador C# en un archivo de registro:

"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":Analizar todas las expresiones LINQ, excepto las colecciones y matrices del sistema

  • "Medium":Analizar todas las expresiones LINQ, excepto las colecciones y matrices del sistema, en archivos que incluyan MongoDB.Driver y sus espacios de nombres anidados únicamente

  • "None":No analizar expresiones LINQ

Importante

La opción de configuración LinqAnalysisVerbosity solo está disponible en C# Analyzer v2.0 y versiones posteriores.

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 generar registros, debe especificar un archivo de registro y la opción OutputInternalLogsToFile.

Utilice la siguiente configuración de ejemplo para generar información de salida del analizador C# en un archivo de registro:

"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": Vista previa de todos los POCO

  • "Medium": Obtenga una vista previa solo de los POCO que forman parte de una expresión LINQ o de constructores o que tienen atributos BSON

  • "None":No previsualizar los POCO

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.

Tip

Para aprender más sobre la telemetría en el C# Analyzer, consulta la sección Telemetría de esta guía.

Accepted Values: true or false
Default: true

Para obtener más información sobre las opciones de configuración que admite C# Analyzer, consulte el código fuente de MongoDB C# Analyzer.

Cuando C# Analyzer analiza su código fuente, la herramienta recopila y envía de forma predeterminada información anónima a MongoDB Inc. para mejorar los productos.

Para deshabilitar esta función, especifique la siguiente opción en su archivo de configuración:

"SendTelemetry": false

Para ver una lista completa de toda la información recopilada por C# Analyzer cuando ha habilitado la telemetría, consulte la página de preguntas frecuentes.

Para obtener más información sobre cómo MongoDB Inc. utiliza los datos recopilados, consulte la Política de privacidad.

Volver

Reglas y contenido del mensaje

En esta página