CA1200: Ne használjon cref-címkéket előtaggal

Tulajdonság Érték
Szabályazonosító CA1200
Cím Ne használjon cref-címkéket előtaggal
Kategória Documentation
A javítás romboló vagy nem romboló Nem törhető
Alapértelmezés szerint engedélyezve a .NET 10-ben Nem
Alkalmazandó nyelvek C# és Visual Basic

Ok

Az cref címke az XML-dokumentációs megjegyzésben egy előtag-ot használ.

Szabály leírása

Az XML-dokumentáció címkéjében szereplő cref attribútum "kódhivatkozást" jelent. Meghatározza, hogy a címke belső szövege kódelem, például típus, metódus vagy tulajdonság. Kerülje a címkék előtagokkal való használatát cref , mert megakadályozza, hogy a fordító ellenőrizze a hivatkozásokat. Emellett megakadályozza, hogy a Visual Studio integrált fejlesztési környezete (IDE) megtalálja és frissítse ezeket a szimbólumhivatkozásokat az újrabontások során. Javasoljuk, hogy a teljes szintaxist előtagok nélkül használja a cref-címkék szimbólumneveire való hivatkozáshoz.

Szabálysértések kijavítása

A szabály megsértésének kijavításához távolítsa el az előtagot a cref címkéből. A következő két kódrészlet például a szabály megsértését és a hiba elhárítását mutatja be:

// 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() { }
}

Mikor kell letiltani a figyelmeztetéseket?

Ezt a figyelmeztetést nyugodtan letilthatja, ha a kódhivatkozásnak előtagot kell használnia, mert a hivatkozott típust nem találja a fordító. Ha például egy kódhivatkozás egy speciális attribútumra hivatkozik a teljes keretrendszerben, de a fájl a hordozható keretrendszeren alapul, letilthatja ezt a figyelmeztetést.

Figyelmeztetés mellőzése

Ha csak egyetlen szabálysértést szeretne letiltani, adjon hozzá előfeldolgozási irányelveket a forrásfájlhoz a szabály letiltásához és újbóli engedélyezéséhez.

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

Ha le szeretné tiltani egy fájl, mappa vagy projekt szabályát, állítsa annak súlyosságát none a konfigurációs fájlban.

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

További információ: Kódelemzési figyelmeztetések letiltása.

Lásd még

  • Last updated on