CA1713: Události by neměly mít předponu před nebo po
TypeName |
EventsShouldNotHaveBeforeOrAfterPrefix |
CheckId |
CA1713 |
Kategorie |
Microsoft.Naming |
Narušující změna |
Narušující |
Příčina
Název události začíná řetězcem "Before" nebo "After".
Popis pravidla
Názvy událostí by měly popisovat akci, která vyvolává 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í dvojice událostí, které jsou aktivovány při zavírání prostředku, je možné tyto události pojmenovat "Closing" a "Closed" namísto "BeforeClose" a "AfterClose".
Jmenné konvence poskytují společný vzhled knihovnám, které pracují s modulem CLR (Common Language Runtime).To snižuje křivku učení, která je vyžadována pro naučení nových softwarových knihoven a zvyšuje důvěru zákazníků, že knihovna byla vyvinuta osobou, která má odborné znalosti s vývojem spravovaného kódu.
Jak vyřešit porušení
Odeberte předponu názvu události a zvažte změnu názvu pomocí přítomného nebo minulého času slovesa.
Kdy potlačit upozornění
Nepotlačujte upozornění na toto pravidlo.