文档菜单
文档首页
/
MongoDB C# 分析器

配置 MongoDB C# 分析器

本页内容

  • 概述
  • 配置
  • 选项
  • 遥测

概述

了解如何在您的 .NET 项目中配置 C# 分析器以及可用的配置选项。

配置

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

  1. 按照安装指南中的说明安装C#分析器.

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

    重要

    命名

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

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

    以下示例配置使C#分析器使用LINQ3 提供程序。

    { "DefaultLinqVersion": "V3" }

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

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

注意

配置是可选的

如果您未指定配置文件，C#分析器将使用所有 配置选项 的默认值。

有关 .NET 项目文件的更多信息，请参阅 了解项目文件。

要了解更多关于 AdditionalFiles 标签的信息，请参阅 Roslyn 文档中的 使用 Additional Files。

选项

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

名称
描述
DefaultLinqVersion
类型: 字符串

描述: C# 分析器使用的 LINQ 提供程序。

提示

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

接受值: "V2" 或 "V3"
默认值: "V2"
EnableVariableTracking
类型: 布尔型

描述: 指定 C# 分析器是否跟踪和组合构建器表达式变量。

提示

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

接受值: true 或 false
默认值: true
LogFileName
类型: 字符串

描述: 指定 C# 分析器写入其内部日志的路径。

重要

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

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

"OutputInternalLogsToFile": true,
"LogFileName": "<path to your logfile>"
接受值: 一个有效的文件路径
默认值: ""
OutputDriverVersion
类型: 布尔型

描述: 指定 C# 分析器是否在诊断消息中包含您的 .NET/C# 驱动程序版本。

接受值: true 或 false
默认值: false
OutputInternalExceptions
类型: 布尔型

描述: 指定 C# 分析器是否在诊断消息中包含内部异常。

接受值: true 或 false
默认值: false
OutputInternalLogsToFile
类型: 布尔型

描述: 指定 C# 分析器是否将内部日志写入文件。

重要

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

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

"OutputInternalLogsToFile": true,
"LogFileName": "<path to your logfile>"
接受值: true 或 false
默认值: false
PocoAnalysisVerbosity
类型: 字符串

描述: 指定 C# 分析器预览哪些 POCOs 作为 JSON。您可以设置此选项为以下值之一

  • "All": 预览所有 POCOs

  • "Medium": 只预览属于 LINQ 或构建器表达式或具有 BSON 属性的 POCOs

  • "None"：不预览POCO

可接受值："All"、"Medium" 或 "None"
默认值："Medium"
SendTelemetry
类型: 布尔型

描述：指定C#分析器是否收集并发送匿名信息到MongoDB Inc.以改进产品。

提示

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

接受值: true 或 false
默认值: true

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

遥测

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

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

"SendTelemetry": false

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

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

返回

规则与消息内容

下一步

已知问题