配置 MongoDB C# 分析器

Overview

了解如何在C# Analyzer .NET项目中配置以及哪些配置选项可用。

配置

要配置 C# 分析器，请执行以下操作：

按照安装指南中的说明安装 C# 分析器。
创建一个名为 mongodb.analyzer.json 的文件，指定C# Analyzer的配置。

重要
命名
您必须将配置文件命名为mongodb.analyzer.json 。
将配置添加到mongodb.analyzer.json文件中。

The following sample configuration makes the C# Analyzer use the LINQ3 provider.
{ "DefaultLinqVersion": "V3" }
将以下内容添加到 .NET 应用程序的.csproj文件的Project标签内：
<ItemGroup> <AdditionalFiles Include="<path to your mongodb.analyzer.json file>" /> </ItemGroup>

注意

可选配置

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

要学习；了解有关.NET项目文件的更多信息，请参阅Microsoft的Understand the Project File（了解项目文件）。

要学习；了解有关AdditionalFiles 标签的更多信息，请参阅 Roslyn 文档中的使用其他文件。

选项

以下是 C# 分析器支持的所有配置选项的描述：

名称

说明

DefaultLinqVersion

类型：string

说明：C# Analyzer 使用的 LINQ 提供商。

提示

要了解有关 LINQ 的更多信息，请参阅分析代码页面。

可接受值："V2" 或 "V3"
默认值："V2"

EnableVariableTracking

类型：布尔值

说明：指定 C# Analyzer 是否追踪和组成构建者表达式变量。

提示

要了解有关表达式构建器的更多信息，请参阅分析代码页面。

可接受值：true 或 false
默认值：true

日志文件名

类型： string

说明： 指定 C# Analyzer 写入其内部日志的路径。

重要

要输出日志，必须同时指定日志文件和OutputInternalLogsToFile选项。

使用以下示例配置使 C# 分析器将信息输出到日志文件：

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

可接受值：有效的文件路径
默认值：""

OutputDriverVersion

类型： 布尔值

说明：指定 C# Analyzer 是否在诊断消息中包含您的 .NET/C# 驱动程序版本。

可接受值：true 或 false
默认值：false

OutputInternalExceptions

类型：布尔值

说明：指定 C# Analyzer 是否在诊断消息中包含内部异常。

可接受值：true 或 false
默认值：false

OutputInternalLogsToFile

类型：布尔值

说明：指定 C# Analyzer 是否将其内部日志写入文件。

重要

要输出日志，必须同时指定日志文件和OutputInternalLogsToFile选项。

使用以下示例配置使 C# 分析器将信息输出到日志文件：

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

可接受值：true 或 false
默认值：false

PocoAnalysisVerbosity

类型：string

说明：指定 C# Analyzer 预览为 JSON 的 POCO。您可以将此选项设置为以下值之一：

"All"：预览所有 POCO
"Medium"：仅预览属于 LINQ 或构建器表达式的一部分或具有 BSON 属性的 POCO
"None"：不预览 POCO

接受的值："All"、"Medium" 或 "None"
默认值："Medium"

SendTelemetry

类型：布尔值

说明：指定 C# Analyzer 是否收集匿名信息并将其发送给 MongoDB Inc. 以改进产品。

提示

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

可接受值：true 或 false
默认值：true

要学习；了解有关C#分析器支持的配置选项的更多信息，请参阅MongoDB C#分析器源代码。

遥测

当 C# 分析器分析源代码时，该工具默认会收集匿名信息并将其发送给 MongoDB Inc. 以改进产品。

要禁用此功能，请在配置文件中指定以下选项：

"SendTelemetry": false

要查看启用遥测后C# Analyzer收集的所有信息的完整列表，请参阅常见问题解答页面。

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