Metadata

ID: csharp-best-practices/diagnostic-analyzer-language

Language: C#

Severity: Warning

Category: Error Prone

Description

This rule is designed to ensure that the correct language is specified for the DiagnosticAnalyzer attribute in C#. The DiagnosticAnalyzer attribute is used to indicate that a class is a diagnostic analyzer, which is a component that analyzes code to find problems. The language parameter specifies the language that the analyzer supports.

It is crucial to accurately specify the language of the DiagnosticAnalyzer because it determines the language syntax and semantics the analyzer will use. If you specify the wrong language, it can lead to incorrect or incomplete code analysis.

How to remediate

To fix this issue, always specify “C#” as the language for DiagnosticAnalyzer in C# projects. For instance, use [DiagnosticAnalyzer("C#")] to indicate that the analyzer supports C# language. Avoid specifying other languages such as [DiagnosticAnalyzer("C")] or [DiagnosticAnalyzer("VB")] in a C# project.

Non-Compliant Code Examples

// language should be C#
[DiagnosticAnalyzer("C")]
class MyAnalyzer : DiagnosticAnalyzer
{
}

Compliant Code Examples

[DiagnosticAnalyzer("C#")]
class MyAnalyzer : DiagnosticAnalyzer
{
}

Seamless integrations. Try Datadog Code Security

Datadog Code Security