DiagnosticDescriptor Construtores

Definição

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Pacote:

Microsoft.CodeAnalysis.Common v4.9.2

Sobrecargas

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])	Crie um DiagnosticDescriptor, que fornece descrição sobre um Diagnostic.
DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])	Crie um DiagnosticDescriptor, que fornece descrição sobre um Diagnostic. OBSERVAÇÃO: para localizáveis title, description e/ou messageFormat, use a sobrecarga DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])do construtor .

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

Source:

DiagnosticDescriptor.cs

Crie um DiagnosticDescriptor, que fornece descrição sobre um 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())

Parâmetros

id

String

Um identificador exclusivo para o diagnóstico. Por exemplo, a ID de diagnóstico de análise de código "CA1001".

title

LocalizableString

Um título localizável curto que descreve o diagnóstico. Por exemplo, para CA1001: "Tipos que possuem campos descartáveis devem ser descartáveis".

messageFormat

LocalizableString

Uma cadeia de caracteres de mensagem de formato localizável, que pode ser passada como o primeiro argumento para ao Format(String, Object[]) criar a mensagem de diagnóstico com esse descritor. Por exemplo, para CA1001: "Implementar IDisposable em '{0}' porque ele cria membros dos seguintes tipos IDisposable: '{1}'.".

category

String

A categoria do diagnóstico (como Design, Nomenclatura etc.). Por exemplo, para CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Gravidade padrão do diagnóstico.

isEnabledByDefault

Boolean

True se o diagnóstico estiver habilitado por padrão.

description

LocalizableString

Uma descrição opcional mais localizável do diagnóstico.

helpLinkUri

String

Um hiperlink opcional que fornece uma descrição mais detalhada sobre o diagnóstico.

customTags

String[]

Marcas personalizadas opcionais para o diagnóstico. Confira WellKnownDiagnosticTags algumas marcas conhecidas.

Comentários

Descritor de exemplo para a regra 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);

Escolha uma ID de diagnóstico apropriada para que ela seja exclusiva.

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

Source:

DiagnosticDescriptor.cs

Crie um DiagnosticDescriptor, que fornece descrição sobre um Diagnostic. OBSERVAÇÃO: para localizáveis title, description e/ou messageFormat, use a sobrecarga DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])do construtor .

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

Parâmetros

id

String

Um identificador exclusivo para o diagnóstico. Por exemplo, a ID de diagnóstico de análise de código "CA1001".

title

String

Um título curto que descreve o diagnóstico. Por exemplo, para CA1001: "Tipos que possuem campos descartáveis devem ser descartáveis".

messageFormat

String

Uma cadeia de caracteres de mensagem de formato, que pode ser passada como o primeiro argumento para ao Format(String, Object[]) criar a mensagem de diagnóstico com esse descritor. Por exemplo, para CA1001: "Implementar IDisposable em '{0}' porque ele cria membros dos seguintes tipos IDisposable: '{1}'.".

category

String

A categoria do diagnóstico (como Design, Nomenclatura etc.). Por exemplo, para CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Gravidade padrão do diagnóstico.

isEnabledByDefault

Boolean

True se o diagnóstico estiver habilitado por padrão.

description

String

Uma descrição mais longa opcional do diagnóstico.

helpLinkUri

String

Um hiperlink opcional que fornece uma descrição mais detalhada sobre o diagnóstico.

customTags

String[]

Marcas personalizadas opcionais para o diagnóstico. Confira WellKnownDiagnosticTags algumas marcas conhecidas.

Comentários

Escolha uma ID de diagnóstico apropriada para que ela seja exclusiva.