RuleDescriptor Clase

Definición

Describe una regla detectada por el motor de reglas y admite la configuración de sus propiedades. Los descriptores heredan las propiedades de RuleConfiguration, para admitir la habilitación o deshabilitación de la regla durante el análisis y la especificación de la gravedad de los problemas creados por la regla.

Esta clase no está pensada para ser subclases por parte de usuarios externos: el servicio de análisis crea instancias de RuleDescriptor .

public abstract class RuleDescriptor : Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration
type RuleDescriptor = class
    inherit RuleConfiguration
Public MustInherit Class RuleDescriptor
Inherits RuleConfiguration
Herencia
RuleDescriptor

Constructores

Nombre Description
RuleDescriptor(String)

Constructor protegido al que se llamará mediante la implementación de clases.

Propiedades

Nombre Description
DisplayDescription

Descripción de la regla. Esta debe ser una breve descripción legible de lo que la regla está pensada para advertir contra o bloquear.

Esto se lee automáticamente desde la propiedad .Metadata

DisplayName

Nombre para mostrar que describe la regla.

Esto se lee automáticamente desde la propiedad .Metadata

Enabled

Especifica si la regla está habilitada y debe incluirse en el análisis de código.

El valor predeterminado es true.

(Heredado de RuleConfiguration)
Metadata

que ISqlAnalysisRuleMetadata describe la regla. Se trata de una propiedad necesaria que deben definirse en subclases.

Namespace

Obtiene el espacio de nombres de la regla. Esta es la parte de la regla que precede al final "." en el nombre del identificador. Por ejemplo, para un identificador de regla "My.Org.MyRuleName", el espacio de nombres sería "My.Org".

(Heredado de RuleConfiguration)
Rule

Instancia real de . SqlAnalysisRule

RuleId

Obtiene el identificador único que se usa para identificar la regla. Este es el identificador completo, que normalmente estaría en el formato "My.Org.MyRuleName".

(Heredado de RuleConfiguration)
Severity

¿Qué gravedad deben tener los problemas creados por la regla?

La gravedad predeterminada es Warning

(Heredado de RuleConfiguration)
ShortRuleId

Obtiene la última parte del identificador de regla. Esta es la parte de la regla que sigue al final "." en el nombre del identificador. Por ejemplo, para un identificador de regla "My.Org.MyRuleName", el identificador de regla corta sería "MyRuleName".

(Heredado de RuleConfiguration)

Se aplica a