对于 AI 代理：可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单
Docs 主页
/
工具
/
C# Analyzer
Docs 主页
/
工具
/
C# Analyzer
Docs 主页
/
工具
/
C# Analyzer

配置 MongoDB C# 分析器

Overview

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

配置

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

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

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

    重要

    命名

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

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

    以下示例配置禁用了变量跟踪：

    { "EnableVariableTracking": "false" }

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

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

注意

可选配置

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

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

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

选项

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

名称
说明

EnableVariableTracking

类型：布尔值

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

提示

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

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

日志文件名

类型：字符串

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

重要

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

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

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

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

LinqAnalysisVerbosity

类型：字符串

描述：指定C#分析器分析哪些 LINQ 表达式。您可以将此选项设立为以下值之一：

  • "All"：分析除系统集合和数组之外的所有 LINQ 表达式

  • "Medium"：分析仅包含 MongoDB.Driver 及其嵌套命名空间的文件中的所有 LINQ 表达式（系统集合和数组除外）

  • "None"：不分析LINQ 表达式

重要

LinqAnalysisVerbosity 配置选项仅在C# Analyzer v2.0 及更高版本中可用。

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

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#分析器将哪些 POCO 预览为JSON。您可以将此选项设立为以下值之一：

  • "All"：预览所有 POCO

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

  • "None"：不预览 POCO

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

SendTelemetry

类型：布尔值

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

提示

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

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

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

遥测

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

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

"SendTelemetry": false

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

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

后退

规则和消息内容

来年

已知问题

在此页面上