診断 ID の選択

  • [アーティクル]

診断 ID は、アナライザーによって生成されるコンパイラ エラーや診断などの特定の診断に関連付けられている文字列です。

ID は、次のようなさまざまな API で表示されます。

診断 ID は、#pragma warning disable や .editorconfig ファイルなど、ソースでも識別子として使用われます。

考慮事項

  • 診断 ID は、一意である必要があります
  • 診断 ID は、C# の有効な識別子である必要があります
  • 診断 ID は、15 文字未満である必要があります
  • 診断 ID は、<PREFIX><number> という形式である必要があります
    • プレフィックスはプロジェクトに固有です
    • 数値は特定の診断を表します

Note

ID が変更されると既存の抑制が無視されるため、診断 ID を変更するのはソースの破壊的変更です。

プレフィックスを 2 文字に制限しないでください (CSXXX や CAXXXX など)。 競合を回避するため、もっと長いプレフィックスを使ってください。 たとえば、System.* の診断では、プレフィックスとして SYSLIB が使われます。