DiagnosticDescriptor Constructeurs

Définition

Espace de noms:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Paquet:

Microsoft.CodeAnalysis.Common v4.12.0

Surcharges

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])	Créez un DiagnosticDescriptor, qui fournit une description d’un Diagnostic.
DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])	Créez un DiagnosticDescriptor, qui fournit une description d’un Diagnostic. REMARQUE : Pour localisables title, description et/ou messageFormat, utilisez la surcharge DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])du constructeur .

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

Source:

DiagnosticDescriptor.cs

Créez un DiagnosticDescriptor, qui fournit une description d’un Diagnostic.

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())

Paramètres

id

String

Identificateur unique pour le diagnostic. Par exemple, l’ID de diagnostic de l’analyse du code « CA1001 ».

title

LocalizableString

Titre court et localisable décrivant le diagnostic. Par exemple, pour CA1001 : « Les types qui possèdent des champs jetables doivent être jetables ».

messageFormat

LocalizableString

Chaîne de message de format localisable, qui peut être passée comme premier argument à Format(String, Object[]) lors de la création du message de diagnostic avec ce descripteur. Par exemple, pour CA1001 : « Implémenter IDisposable sur «{0} », car il crée des membres des types IDisposable suivants : «{1} ».

category

String

Catégorie du diagnostic (par exemple, Conception, Nommage, etc.). Par exemple, pour CA1001 : « Microsoft.Design ».

defaultSeverity

DiagnosticSeverity

Gravité par défaut du diagnostic.

isEnabledByDefault

Boolean

True si le diagnostic est activé par défaut.

description

LocalizableString

Description facultative plus longue et localisable du diagnostic.

helpLinkUri

String

Lien hypertexte facultatif qui fournit une description plus détaillée du diagnostic.

customTags

String[]

Balises personnalisées facultatives pour le diagnostic. Consultez WellKnownDiagnosticTags pour obtenir des balises bien connues.

Remarques

Exemple de descripteur pour la règle 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);

Choisissez un ID de diagnostic approprié de sorte qu’il soit unique.

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

Source:

DiagnosticDescriptor.cs

Créez un DiagnosticDescriptor, qui fournit une description d’un Diagnostic. REMARQUE : Pour localisables title, description et/ou messageFormat, utilisez la surcharge DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])du constructeur .

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())

Paramètres

id

String

Identificateur unique pour le diagnostic. Par exemple, l’ID de diagnostic de l’analyse du code « CA1001 ».

title

String

Titre court décrivant le diagnostic. Par exemple, pour CA1001 : « Les types qui possèdent des champs jetables doivent être jetables ».

messageFormat

String

Chaîne de message de format, qui peut être passée comme premier argument à Format(String, Object[]) lors de la création du message de diagnostic avec ce descripteur. Par exemple, pour CA1001 : « Implémenter IDisposable sur «{0} », car il crée des membres des types IDisposable suivants : «{1} ».

category

String

Catégorie du diagnostic (par exemple, Conception, Nommage, etc.). Par exemple, pour CA1001 : « Microsoft.Design ».

defaultSeverity

DiagnosticSeverity

Gravité par défaut du diagnostic.

isEnabledByDefault

Boolean

True si le diagnostic est activé par défaut.

description

String

Description facultative plus longue du diagnostic.

helpLinkUri

String

Lien hypertexte facultatif qui fournit une description plus détaillée du diagnostic.

customTags

String[]

Balises personnalisées facultatives pour le diagnostic. Consultez WellKnownDiagnosticTags pour obtenir des balises bien connues.

Remarques

Choisissez un ID de diagnostic approprié de sorte qu’il soit unique.