DiagnosticDescriptor Konstruktoren

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Paket:

Microsoft.CodeAnalysis.Common v4.9.2

Überlädt

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])	Erstellen Sie einen DiagnosticDescriptor, der eine Beschreibung zu einem Diagnosticbereitstellt.
DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])	Erstellen Sie einen DiagnosticDescriptor, der eine Beschreibung zu einem Diagnosticbereitstellt. HINWEIS: Verwenden Sie für lokalisierbare title- description und/oder messageFormat- Konstruktorüberladung DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[]).

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])

Source:

DiagnosticDescriptor.cs

Erstellen Sie einen DiagnosticDescriptor, der eine Beschreibung zu einem Diagnosticbereitstellt.

public DiagnosticDescriptor (string id, Microsoft.CodeAnalysis.LocalizableString title, Microsoft.CodeAnalysis.LocalizableString messageFormat, string category, Microsoft.CodeAnalysis.DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, Microsoft.CodeAnalysis.LocalizableString? description = default, string? helpLinkUri = default, params string[] customTags);

new Microsoft.CodeAnalysis.DiagnosticDescriptor : string * Microsoft.CodeAnalysis.LocalizableString * Microsoft.CodeAnalysis.LocalizableString * string * Microsoft.CodeAnalysis.DiagnosticSeverity * bool * Microsoft.CodeAnalysis.LocalizableString * string * string[] -> Microsoft.CodeAnalysis.DiagnosticDescriptor

Public Sub New (id As String, title As LocalizableString, messageFormat As LocalizableString, category As String, defaultSeverity As DiagnosticSeverity, isEnabledByDefault As Boolean, Optional description As LocalizableString = Nothing, Optional helpLinkUri As String = Nothing, ParamArray customTags As String())

Parameter

id

String

Ein eindeutiger Bezeichner für die Diagnose. Beispiel: Codeanalysediagnose-ID "CA1001".

title

LocalizableString

Ein kurzer lokalisierbarer Titel, der die Diagnose beschreibt. Beispiel für CA1001: "Typen, die einwegbare Felder besitzen, sollten wegwerfbar sein".

messageFormat

LocalizableString

Eine lokalisierbare Format-Nachrichtenzeichenfolge, die beim Erstellen der Diagnosenachricht mit diesem Deskriptor als erstes Argument Format(String, Object[]) übergeben werden kann. Beispiel für CA1001: "Implementieren von IDisposable auf "{0}", da Elemente der folgenden IDisposable-Typen erstellt werden: '{1}'."

category

String

Die Kategorie der Diagnose (z. B. Entwurf, Benennung usw.). Beispiel für CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Standardschweregrad der Diagnose.

isEnabledByDefault

Boolean

True, wenn die Diagnose standardmäßig aktiviert ist.

description

LocalizableString

Eine optionale längere lokalisierbare Beschreibung der Diagnose.

helpLinkUri

String

Ein optionaler Link, der eine ausführlichere Beschreibung der Diagnose enthält.

customTags

String[]

Optionale benutzerdefinierte Tags für die Diagnose. Einige bekannte Tags finden Sie WellKnownDiagnosticTags unter.

Hinweise

Beispieldeskriptor für regel CA1001:

internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor(RuleId,
    new LocalizableResourceString(nameof(FxCopRulesResources.TypesThatOwnDisposableFieldsShouldBeDisposable), FxCopRulesResources.ResourceManager, typeof(FxCopRulesResources)),
    new LocalizableResourceString(nameof(FxCopRulesResources.TypeOwnsDisposableFieldButIsNotDisposable), FxCopRulesResources.ResourceManager, typeof(FxCopRulesResources)),
    FxCopDiagnosticCategory.Design,
    DiagnosticSeverity.Warning,
    isEnabledByDefault: true,
    helpLinkUri: "http://msdn.microsoft.com/library/ms182172.aspx",
    customTags: DiagnosticCustomTags.Microsoft);

Wählen Sie eine geeignete Diagnose-ID aus, sodass sie eindeutig ist.

DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])

Source:

DiagnosticDescriptor.cs

Erstellen Sie einen DiagnosticDescriptor, der eine Beschreibung zu einem Diagnosticbereitstellt. HINWEIS: Verwenden Sie für lokalisierbare title- description und/oder messageFormat- Konstruktorüberladung DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[]).

public DiagnosticDescriptor (string id, string title, string messageFormat, string category, Microsoft.CodeAnalysis.DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, string? description = default, string? helpLinkUri = default, params string[] customTags);

new Microsoft.CodeAnalysis.DiagnosticDescriptor : string * string * string * string * Microsoft.CodeAnalysis.DiagnosticSeverity * bool * string * string * string[] -> Microsoft.CodeAnalysis.DiagnosticDescriptor

Public Sub New (id As String, title As String, messageFormat As String, category As String, defaultSeverity As DiagnosticSeverity, isEnabledByDefault As Boolean, Optional description As String = Nothing, Optional helpLinkUri As String = Nothing, ParamArray customTags As String())

Parameter

id

String

Ein eindeutiger Bezeichner für die Diagnose. Beispiel: Codeanalysediagnose-ID "CA1001".

title

String

Ein kurzer Titel, der die Diagnose beschreibt. Beispiel für CA1001: "Typen, die einwegbare Felder besitzen, sollten wegwerfbar sein".

messageFormat

String

Eine Formatnachrichtenzeichenfolge, die beim Erstellen der Diagnosenachricht mit diesem Deskriptor als erstes Argument Format(String, Object[]) übergeben werden kann. Beispiel für CA1001: "Implementieren von IDisposable auf "{0}", da Elemente der folgenden IDisposable-Typen erstellt werden: '{1}'."

category

String

Die Kategorie der Diagnose (z. B. Entwurf, Benennung usw.). Beispiel für CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Standardschweregrad der Diagnose.

isEnabledByDefault

Boolean

True, wenn die Diagnose standardmäßig aktiviert ist.

description

String

Eine optionale längere Beschreibung der Diagnose.

helpLinkUri

String

Ein optionaler Link, der eine ausführlichere Beschreibung der Diagnose enthält.

customTags

String[]

Optionale benutzerdefinierte Tags für die Diagnose. Einige bekannte Tags finden Sie WellKnownDiagnosticTags unter.

Hinweise

Wählen Sie eine geeignete Diagnose-ID aus, sodass sie eindeutig ist.