AL0054 - Diagnostic missing from documentation

Diagnostics defined in code should be documented

Source: Al0054ToAl0056DiagnosticsAlignmentAnalyzer.cs

Description

A diagnostic ID is defined in the analyzer source code but has no corresponding documentation page. All diagnostics should be documented for discoverability.

Bad Code

// DiagnosticIds.cs defines AL0099
public const string MyRule = "AL0099";
// But no docs/rules/AL0099.md exists

Good Code

// DiagnosticIds.cs defines AL0099
public const string MyRule = "AL0099";
// And docs/rules/AL0099.md exists with proper documentation

Properties

• Category: VersionManagement
• Severity: Warning
• Enabled by default: True
• Code fix available: False

Configuration

dotnet_diagnostic.AL0054.severity = warning