CA1200: Evitare di usare tag cref con un prefisso
| Proprietà | valore |
|---|---|
| ID regola | CA1200 |
| Titolo | Evitare l'uso di tag cref con un prefisso |
| Categoria | Documentazione |
| Correzione che causa un'interruzione o un'interruzione | Nessuna interruzione |
| Abilitato per impostazione predefinita in .NET 8 | No |
Causa
Il tag cref in un commento della documentazione XML usa un prefisso.
Descrizione regola
L'attributo cref in un tag di documentazione XML significa "riferimento al codice". Specifica che il testo all'interno del tag è un elemento di codice, ad esempio un tipo, un metodo o una proprietà. Evitare di usare cref tag con prefissi, perché impedisce al compilatore di verificare i riferimenti. Impedisce inoltre all'ambiente di sviluppo integrato (IDE) di Visual Studio di trovare e aggiornare questi riferimenti a simboli durante il refactoring. È consigliabile usare la sintassi completa senza prefissi per fare riferimento ai nomi dei simboli nei tag cref.
Come correggere le violazioni
Per correggere una violazione di questa regola, rimuovere il prefisso dal cref tag . Ad esempio, i due frammenti di codice seguenti mostrano una violazione della regola e come risolverli:
// 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() { }
}
Quando eliminare gli avvisi
È possibile eliminare questo avviso se il riferimento al codice deve usare un prefisso perché il tipo a cui si fa riferimento non è individuabile dal compilatore. Ad esempio, se un riferimento al codice fa riferimento a un attributo speciale nel framework completo, ma il file viene compilato in base al framework portabile, è possibile eliminare questo avviso.
Eliminare un avviso
Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.
#pragma warning disable CA1200
// The code that's violating the rule is on this line.
#pragma warning restore CA1200
Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.
[*.{cs,vb}]
dotnet_diagnostic.CA1200.severity = none
Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.
