CA1200: Vermijd het gebruik van cref-tags met een voorvoegsel
| Eigenschappen | Weergegeven als |
|---|---|
| Regel-id | CA1200 |
| Titel | Vermijd het gebruik van cref-tags met een voorvoegsel |
| Categorie | Documentatie |
| Oplossing is brekend of niet-brekend | Niet-brekend |
| Standaard ingeschakeld in .NET 8 | Nee |
Oorzaak
De cref-tag in een XML-documentatiecommentaar maakt gebruik van een voorvoegsel.
Beschrijving van regel
Het cref-kenmerk in een XML-documentatietag betekent 'codereferentie '. Hiermee geeft u op dat de binnenste tekst van de tag een code-element is, zoals een type, methode of eigenschap. Vermijd het gebruik van cref tags met voorvoegsels, omdat hiermee wordt voorkomen dat de compiler verwijzingen verifieert. Het voorkomt ook dat de IDE (Integrated Development Environment) van Visual Studio deze symboolverwijzingen tijdens herstructureringen kan vinden en bijwerken. Het wordt aanbevolen om de volledige syntaxis zonder voorvoegsels te gebruiken om te verwijzen naar symboolnamen in cref-tags.
Schendingen oplossen
Als u een schending van deze regel wilt oplossen, verwijdert u het voorvoegsel uit de cref tag. In de volgende twee codefragmenten ziet u bijvoorbeeld een schending van de regel en hoe u deze kunt oplossen:
// 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() { }
}
Wanneer waarschuwingen onderdrukken
Het is veilig om deze waarschuwing te onderdrukken als de codeverwijzing een voorvoegsel moet gebruiken omdat het type waarnaar wordt verwezen niet kan worden gevonden door de compiler. Als een codeverwijzing bijvoorbeeld verwijst naar een speciaal kenmerk in het volledige framework, maar het bestand wordt gecompileerd op basis van het draagbare framework, kunt u deze waarschuwing onderdrukken.
Een waarschuwing onderdrukken
Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.
#pragma warning disable CA1200
// The code that's violating the rule is on this line.
#pragma warning restore CA1200
Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.
[*.{cs,vb}]
dotnet_diagnostic.CA1200.severity = none
Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.
