Share via

CA1713: Händelser bör inte ha före eller efter prefixet

  • Artikel
Property Värde
Regel-ID CA1713
Rubrik Händelser ska inte ha före eller efter prefixet
Kategori Namngivning
Korrigeringen är icke-bakåtkompatibel Bryta
Aktiverad som standard i .NET 8 Nej

Orsak

Namnet på en händelse börjar med "Före" eller "Efter".

Regelbeskrivning

Händelsenamn bör beskriva den åtgärd som genererar händelsen. Om du vill namnge relaterade händelser som genereras i en specifik sekvens använder du nutid eller tidigare tempus för att ange den relativa positionen i sekvensen av åtgärder. När du till exempel namnger ett par händelser som genereras när en resurs stängs kan du ge den namnet "Closing" och "Closed", i stället för "BeforeClose" och "AfterClose".

Namngivningskonventioner ger ett vanligt utseende för bibliotek som riktar sig till den gemensamma språkkörningen. Detta minskar inlärningskurvan som krävs för nya programvarubibliotek och ökar kundernas förtroende för att biblioteket har utvecklats av någon som har kunskaper om att utveckla hanterad kod.

Så här åtgärdar du överträdelser

Ta bort prefixet från händelsenamnet och överväg att ändra namnet så att det använder verbets nuvarande eller tidigare tempus.

När du ska ignorera varningar

Ignorera inte en varning från den här regeln.