Docs 菜单
Docs 主页
/
MongoDB C# Analyzer

配置 MongoDB C# 分析器

在此页面上

  • Overview
  • 配置
  • 选项
  • 遥测

Overview

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

配置

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

  1. C# Analyzer按照 安装指南中的说明 安装 。

  2. 创建一个名为 mongodb.analyzer.json的文件，指定 C# 分析器的配置。

    重要

    命名

    您必须将配置文件命名为mongodb.analyzer.json 。

  3. 将配置添加到mongodb.analyzer.json文件中。

    以下示例配置使C# Analyzer使用 LINQ3提供商。

    { "DefaultLinqVersion": "V3" }

  4. 将以下内容添加到 .NET 应用程序的.csproj文件的Project标签内：

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

注意

可选配置

如果不指定配置文件， C# Analyzer将使用所有配置选项的默认值。

To learn more about .NET project files, see Understanding the Project File from Microsoft.

要学习；了解有关AdditionalFiles 标签的详情，请参阅 使用其他文件 在 Roslyn 文档中。

选项

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

名称
说明
DefaultLinqVersion
Type: string

Description: The LINQ provider the C# Analyzer uses.

提示

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

Accepted Values: "V2" or "V3"
Default: "V2"
EnableVariableTracking
Type: boolean

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

提示

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

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

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

重要

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

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

"OutputInternalLogsToFile": true,
"LogFileName": "<path to your logfile>"
Accepted Values: A valid file path
Default: ""
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.

重要

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

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

"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"：预览所有 POCO

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

  • "None"：不预览 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.

提示

若要了解有关 C# 分析器中遥测的更多信息，请参阅本指南的“遥测”部分。

Accepted Values: true or false
Default: true

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

遥测

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

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

"SendTelemetry": false

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

要详细了解 MongoDB Inc. 如何使用收集的数据，请参阅隐私政策。

后退

规则和消息内容

来年

已知问题