CA1507: Sztring helyett használható nameof

Tulajdonság	Érték
Szabályazonosító	CA1507
Cím	Használat nameof sztring helyett
Kategória	Fenntarthatóság
A javítás kompatibilitástörő vagy nem törik	Nem törés
Alapértelmezés szerint engedélyezve a .NET 10-ben	Javaslatként

Ok

A string metódus argumentumaként egy olyan konstanst vagy állandót használ a rendszer, amely megfelel a tartalmazó metódus egy paraméterének vagy egy olyan tulajdonság nevének, amely megfelel a metódusnak.

Szabály leírása

A CA1507 szabály a literál argumentumként való string használatát jelöli egy metódushoz vagy konstruktorhoz, ahol a (Visual Basic) kifejezés neveNameOf karbantarthatóságot adna. A szabály akkor aktiválódik, ha az alábbi feltételek teljesülnek:

• Az argumentum egy string konstans vagy állandó.

• Az argumentum a metódus vagy a meghívandó konstruktor egy -typed paraméterének felel meg string(azaz a hívási helyen nincs átalakítás).

• Vagy:

  • A paraméter paramName deklarált neve és a konstans állandó értéke string megegyezik annak a metódusnak, lambda vagy helyi függvénynek a nevével, amelyen belül a metódust vagy konstruktort meghívják.

  • A paraméter propertyName deklarált neve és a string konstans állandó értéke megegyezik annak a tulajdonságnak a nevével, amelyben a metódust vagy konstruktort meghívják.

A CA1507 szabály javítja a kód karbantarthatóságát azokban az esetekben, amikor a paramétert a jövőben átnevezhetik, de a string literálist véletlenül nem nevezik át. A használatával nameofa rendszer átnevezi a szimbólumot, amikor egy újrabontási művelettel átnevezi a paramétert. Emellett a fordító a paraméter nevében előforduló helyesírási hibákat is észleli.

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

A szabálysértés kijavításához cserélje le a string literált a (Visual Basic) kifejezésben szereplő névreNameOf. 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:

public Book(string title)
{
    // Violates rule CA1507
    Title = title ?? throw new ArgumentNullException("title", "All books must have a title.");
}

public Book(string title)
{
    // Resolves rule CA1507 violation
    Title = title ?? throw new ArgumentNullException(nameof(title), "All books must have a title.");
}

Tipp.

Ehhez a szabályhoz kódjavítás érhető el a Visual Studióban. A használatához vigye a kurzort a literálra, és nyomja le a string Ctrl Válassza a Use nameof (Név használata) lehetőséget a megjelenő lehetőségek listájában szereplő szimbólumnevek kifejezéséhez.

Mikor kell letiltani a figyelmeztetéseket?

Ha nem aggódik a kód karbantarthatósága miatt, nyugodtan letilthatja a szabály megsértését.

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 CA1507
// The code that's violating the rule is on this line.
#pragma warning restore CA1507

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.CA1507.severity = none

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

Kapcsolódó szabályok

• CA2208: Argumentum-kivételek helyes példányosítása

Lásd még

• Karbantarthatósági szabályok