CA1713: Události by neměly mít předponu před nebo po

Vlastnost Hodnota
ID pravidla CA1713
Název Události by neměly mít předponu před nebo po
Kategorie Pojmenování
Oprava způsobující chybu nebo chybu způsobující chybu Narušující
Povoleno ve výchozím nastavení v .NET 8 No

Příčina

Název události začíná na "Before" nebo "After".

Popis pravidla

Názvy událostí by měly popisovat akci, která vyvolá událost. Pro pojmenování souvisejících událostí vyvolaných v určitém pořadí je vhodné používat přítomný a minulý čas, který naznačí relativní pozici v pořadí akcí. Například při pojmenování páru událostí, které jsou vyvolány při zavření prostředku, můžete ji pojmenovat "Closing" a "Closed" místo "BeforeClose" a "AfterClose".

Konvence vytváření názvů poskytují společný vzhled knihoven, které cílí na modul CLR (Common Language Runtime). To snižuje křivku učení, která je nutná pro nové softwarové knihovny, a zvyšuje důvěru zákazníků, že knihovna byla vyvinuta někým, kdo má zkušenosti s vývojem spravovaného kódu.

Jak opravit porušení

Odeberte předponu z názvu události a zvažte změnu názvu tak, aby používal aktuální nebo minulé časy slovesa.

Kdy potlačit upozornění

Nepotlačujte upozornění na toto pravidlo.