CA1200: Evitar el uso de etiquetas cref con un prefijo

  • Artículo
Propiedad Value
Identificador de la regla CA1200
Título Evitar el uso de etiquetas cref con un prefijo
Categoría Documentación
La corrección es problemática o no problemática Poco problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

La etiqueta cref en un comentario de documentación XML usa un prefijo.

Descripción de la regla

El atributo cref en una etiqueta de documentación XML significa "referencia de código". Especifica que el texto interno de la etiqueta es un elemento de código, como un tipo, un método o una propiedad. Evite el uso de etiquetas cref con prefijos, ya que impide que el compilador compruebe las referencias. También impide que el entorno de desarrollo integrado (IDE) de Visual Studio busque y actualice estas referencias de símbolos durante las refactorizaciones. Se recomienda usar la sintaxis completa sin prefijos para hacer referencia a los nombres de símbolos en etiquetas cref.

Cómo corregir infracciones

Para corregir una infracción de esta regla, quite el prefijo de la etiqueta cref. Por ejemplo, en los dos fragmentos de código siguientes se muestra una infracción de la regla y cómo corregirla:

// Violates CA1200
/// <summary>
/// Type <see cref="T:C" /> contains method <see cref="F:C.F" />
/// </summary>
class C
{
    public void F() { }
}

// Does not violate CA1200
/// <summary>
/// Type <see cref="C" /> contains method <see cref="F" />
/// </summary>
class C
{
    public void F() { }
}

Cuándo suprimir las advertencias

Es seguro suprimir esta advertencia si la referencia de código debe usar un prefijo porque el compilador no encuentra el tipo al que se hace referencia. Por ejemplo, si una referencia de código hace referencia a un atributo especial del marco completo, pero el archivo se compila con el marco portátil, puede suprimir esta advertencia.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

#pragma warning disable CA1200
// The code that's violating the rule is on this line.
#pragma warning restore CA1200

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

[*.{cs,vb}]
dotnet_diagnostic.CA1200.severity = none

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Consulte también