DiagnosticDescriptor Constructores

Definición

Espacio de nombres:

Microsoft.CodeAnalysis

Ensamblado:

Microsoft.CodeAnalysis.dll

Paquete:

Microsoft.CodeAnalysis.Common v4.9.2

Sobrecargas

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])	Cree un DiagnosticDescriptor, que proporciona una descripción sobre .Diagnostic
DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])	Cree un DiagnosticDescriptor, que proporciona una descripción sobre .Diagnostic NOTA: Para localizable titley description /o messageFormat, use la sobrecarga DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])del constructor .

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

Source:

DiagnosticDescriptor.cs

Cree un DiagnosticDescriptor, que proporciona una descripción sobre .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

Identificador único para el diagnóstico. Por ejemplo, el identificador de diagnóstico de análisis de código "CA1001".

title

LocalizableString

Título localizable breve que describe el diagnóstico. Por ejemplo, para CA1001: "Los tipos que poseen campos descartables deben ser descartables".

messageFormat

LocalizableString

Cadena de mensaje de formato localizable, que se puede pasar como primer argumento a Format(String, Object[]) al crear el mensaje de diagnóstico con este descriptor. Por ejemplo, para CA1001: "Implementar IDisposable en '{0}' porque crea miembros de los siguientes tipos IDisposable: '{1}'".

category

String

Categoría del diagnóstico (como Diseño, Nomenclatura, etc.). Por ejemplo, para CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Gravedad predeterminada del diagnóstico.

isEnabledByDefault

Boolean

True si el diagnóstico está habilitado de forma predeterminada.

description

LocalizableString

Una descripción más localizable opcional del diagnóstico.

helpLinkUri

String

Un hipervínculo opcional que proporciona una descripción más detallada sobre el diagnóstico.

customTags

String[]

Etiquetas personalizadas opcionales para el diagnóstico. Consulte WellKnownDiagnosticTags para obtener algunas etiquetas conocidas.

Comentarios

Descriptor de ejemplo para la regla 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);

Elija un identificador de diagnóstico adecuado para que sea único.

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

Source:

DiagnosticDescriptor.cs

Cree un DiagnosticDescriptor, que proporciona una descripción sobre .Diagnostic NOTA: Para localizable titley description /o messageFormat, use la sobrecarga DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])del constructor .

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

Identificador único para el diagnóstico. Por ejemplo, el identificador de diagnóstico de análisis de código "CA1001".

title

String

Título corto que describe el diagnóstico. Por ejemplo, para CA1001: "Los tipos que poseen campos descartables deben ser descartables".

messageFormat

String

Cadena de mensaje de formato, que se puede pasar como primer argumento a Format(String, Object[]) al crear el mensaje de diagnóstico con este descriptor. Por ejemplo, para CA1001: "Implementar IDisposable en '{0}' porque crea miembros de los siguientes tipos IDisposable: '{1}'".

category

String

Categoría del diagnóstico (como Diseño, Nomenclatura, etc.). Por ejemplo, para CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Gravedad predeterminada del diagnóstico.

isEnabledByDefault

Boolean

True si el diagnóstico está habilitado de forma predeterminada.

description

String

Descripción más larga opcional del diagnóstico.

helpLinkUri

String

Un hipervínculo opcional que proporciona una descripción más detallada sobre el diagnóstico.

customTags

String[]

Etiquetas personalizadas opcionales para el diagnóstico. Consulte WellKnownDiagnosticTags para obtener algunas etiquetas conocidas.

Comentarios

Elija un identificador de diagnóstico adecuado para que sea único.