AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
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 でサポートされているすべての構成オプションの説明です。

名前
説明

EnableVvariableTracking

タイプ: ブール値

説明:C# Analyzerがビルダ式変数を追跡して作成するかどうかを指定します。

Tip

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

受け入れ可能な値: true または false
デフォルト: true

LogFileName

タイプ: string

説明:C# Analyzerが内部ログの書き込み (write)を行うパスを指定します。

重要

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

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

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

受け入れ可能な値: 有効なファイル パス
デフォルト: ""

LinqAnalysisVerbosity

タイプ: string

説明: C# Analyzer が分析する LINQ 式を指定します。このオプションは、次のいずれかの値に設定できます。

  • "All": システム コレクションと配列を除くすべての LINQ 式を分析する

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

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

重要

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

使用可能な値: "All"、"Medium"または "None"
デフォルト: "Medium"

出力ドライバーバージョン

タイプ: ブール値

説明: C# Analyzer の診断メッセージに .NET/C# ドライバーのバージョンを含めるかどうかを指定します。

受け入れる値: true または false
デフォルト: false

OutputInternalExceptions

タイプ: ブール値

説明: C# Analyzer が診断メッセージに内部例外を含めるかどうかを指定します。

受け入れる値: true または false
デフォルト: false

出力内部ログsToFile

タイプ: ブール値

説明: C# Analyzer が内部ログをファイルに書き込む (write)かどうかを指定します。

重要

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

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

"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. に送信するかどうかを指定します。

Tip

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

受け入れ可能な値: true または false
デフォルト: true

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

テレメトリー

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

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

"SendTelemetry": false

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

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

戻る

ルールとメッセージ内容

次へ

既知の問題点

項目一覧