DiagnosticDescriptor Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a description about a Diagnostic
public ref class DiagnosticDescriptor sealed : IEquatable<Microsoft::CodeAnalysis::DiagnosticDescriptor ^>public sealed class DiagnosticDescriptor : IEquatable<Microsoft.CodeAnalysis.DiagnosticDescriptor>type DiagnosticDescriptor = class
interface IEquatable<DiagnosticDescriptor>Public NotInheritable Class DiagnosticDescriptor
Implements IEquatable(Of DiagnosticDescriptor)- Inheritance
-
DiagnosticDescriptor
- Implements
Constructors
| DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[]) |
Create a DiagnosticDescriptor, which provides description about a Diagnostic. |
| DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[]) |
Create a DiagnosticDescriptor, which provides description about a Diagnostic.
NOTE: For localizable |
Properties
| Category |
The category of the diagnostic (like Design, Naming etc.) |
| CustomTags |
Custom tags for the diagnostic. |
| DefaultSeverity |
The default severity of the diagnostic. |
| Description |
An optional longer localizable description for the diagnostic. |
| HelpLinkUri |
An optional hyperlink that provides more detailed information regarding the diagnostic. |
| Id |
An unique identifier for the diagnostic. |
| IsEnabledByDefault |
Returns true if the diagnostic is enabled by default. |
| MessageFormat |
A localizable format message string, which can be passed as the first argument to Format(String, Object[]) when creating the diagnostic message with this descriptor. |
| Title |
A short localizable title describing the diagnostic. |
Methods
| Equals(DiagnosticDescriptor) | |
| Equals(Object) | |
| GetEffectiveSeverity(CompilationOptions) |
Gets the effective severity of diagnostics created based on this descriptor and the given CompilationOptions. |
| GetHashCode() | |
