Docs Menu
Docs Home
/
ツール
/
C# Analyzer
Docs Home
/
ツール
/
C# Analyzer
Docs Home
/
ツール
/
C# Analyzer

MongoDB C# Analyzerの設定

Overview

C# Analyzer.NETプロジェクトで を構成する方法と、使用可能な構成オプションを確認します。

構成

C# Analyzerを構成するには、次のアクションを実行します。

  1. インストールガイドのに記載されているように C# Analyzer をインストールします。

  2. mongodb.analyzer.jsonという名前の C# Analyzer の構成を指定するファイルを作成します。

    重要

    命名

    構成ファイルにはmongodb.analyzer.jsonという名前を付ける必要があります。

  3. 構成をmongodb.analyzer.jsonファイルに追加します。

    次のサンプル構成では、変数追跡が無効になります。

    { "EnableVariableTracking": "false" }

  4. Projectタグ内の .NET アプリケーション用の.csprojファイルに以下を追加します。

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

注意

構成は任意

構成ファイルを指定しない場合、 C# Analyzer はすべての 構成オプションにデフォルト値を使用します。

.NETプロジェクトファイルの詳細については、Microsoftのプロジェクト ファイルの理解を参照してください。

AdditionalFiles タグの詳細については、Roslyn ドキュメントの「追加ファイルの使用」を参照してください。

オプション

以下は、C# Analyzer でサポートされているすべての構成オプションの説明です。

名前
説明
EnableVariableTracking
Type: boolean

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

Tip

ビルダ式の詳細については、 「 コードの分析 」ページを参照してください。

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# Analyzer の出力情報をログファイルに作成します。

"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": システム コレクションと配列を除くすべての LINQ 式を分析する

  • "Medium": MongoDB.Driver とそのネストされた名前空間のみを含むファイルで、システム コレクションと配列を除くすべての LINQ 式を分析します。

  • "None": LINQ 式を分析しない

重要

LinqAnalysisVerbosity 構成オプションはC# Analyzer v2.0 以降でのみ使用できます。

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.

重要

ログを出力するには、ログファイルとOutputInternalLogsToFileオプションの両方を指定する必要があります。

次のサンプル構成を使用して、C# Analyzer の出力情報をログファイルに作成します。

"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.

Tip

C# Analyzer のテレメトリの詳細については、このガイドの「 テレメトリ 」セクションを参照してください。

Accepted Values: true or false
Default: true

C# Analyzer がサポートする構成オプションの詳細については、MongoDB C# Analyzerソースコード を参照してください。

テレメトリー

C# Analyzer がソースコードを分析すると、このツールはデフォルトで製品を改善するために匿名化された情報を収集し、MongoDB Inc. に送信します。

この機能を無効にするには、構成ファイルで次のオプションを指定します。

"SendTelemetry": false

テレメトリを有効にした場合に C# Analyzer によって収集されたすべての情報の完全なリストを表示するには、 FAQページを参照してください。

MongoDB Inc. が収集されたデータをどのように使用するかについて詳しくは、「プライバシー ポリシー 」を参照してください。

戻る

ルールとメッセージ内容

次へ

既知の問題点

項目一覧