DiagnosticDescriptor Costruttori

Definizione

Spazio dei nomi:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Pacchetto:

Microsoft.CodeAnalysis.Common v4.9.2

Overload

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])	Creare un diagnosticDescriptor, che fornisce una descrizione su un Diagnosticoggetto .
DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])	Creare un diagnosticDescriptor, che fornisce una descrizione su un Diagnosticoggetto . NOTA: per localizzabili titlee description /o messageFormat, usare l'overload DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])del costruttore .

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

Source:

DiagnosticDescriptor.cs

Creare un diagnosticDescriptor, che fornisce una descrizione su un Diagnosticoggetto .

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

Parametri

id

String

Identificatore univoco per la diagnostica. Ad esempio, l'ID diagnostico di analisi del codice "CA1001".

title

LocalizableString

Titolo localizzatore breve che descrive la diagnostica. Ad esempio, per CA1001: "Tipi che devono essere monouso".

messageFormat

LocalizableString

Stringa di messaggio di formato localizzabile, che può essere passata come primo argomento a Format(String, Object[]) quando si crea il messaggio di diagnostica con questo descrittore. Ad esempio, per CA1001: "Implementare IDisposable su '' perché crea membri dei tipi IDisposable seguenti: '{0}{1}'".

category

String

Categoria della diagnostica , ad esempio Design, Denominazione e così via. Ad esempio, per CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Gravità predefinita della diagnostica.

isEnabledByDefault

Boolean

True se la diagnostica è abilitata per impostazione predefinita.

description

LocalizableString

Descrizione localizzabile facoltativa della diagnostica.

helpLinkUri

String

Collegamento ipertestuale facoltativo che fornisce una descrizione più dettagliata relativa alla diagnostica.

customTags

String[]

Tag personalizzati facoltativi per la diagnostica. Vedere WellKnownDiagnosticTags per alcuni tag noti.

Commenti

Descrittore di esempio per la regola 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);

Scegliere un ID di diagnostica appropriato in modo che sia univoco.

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

Source:

DiagnosticDescriptor.cs

Creare un diagnosticDescriptor, che fornisce una descrizione su un Diagnosticoggetto . NOTA: per localizzabili titlee description /o messageFormat, usare l'overload DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])del costruttore .

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

Parametri

id

String

Identificatore univoco per la diagnostica. Ad esempio, l'ID diagnostico di analisi del codice "CA1001".

title

String

Titolo breve che descrive la diagnostica. Ad esempio, per CA1001: "Tipi che devono essere monouso".

messageFormat

String

Stringa di messaggio di formato, che può essere passata come primo argomento a Format(String, Object[]) quando si crea il messaggio di diagnostica con questo descrittore. Ad esempio, per CA1001: "Implementare IDisposable su '' perché crea membri dei tipi IDisposable seguenti: '{0}{1}'".

category

String

Categoria della diagnostica , ad esempio Design, Denominazione e così via. Ad esempio, per CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Gravità predefinita della diagnostica.

isEnabledByDefault

Boolean

True se la diagnostica è abilitata per impostazione predefinita.

description

String

Descrizione facoltativa più lunga della diagnostica.

helpLinkUri

String

Collegamento ipertestuale facoltativo che fornisce una descrizione più dettagliata relativa alla diagnostica.

customTags

String[]

Tag personalizzati facoltativi per la diagnostica. Vedere WellKnownDiagnosticTags per alcuni tag noti.

Commenti

Scegliere un ID di diagnostica appropriato in modo che sia univoco.