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, která může být destruktivní nebo nedestruktivní	Přerušující
Povoleno ve výchozím nastavení v .NET 10	Ne
Příslušné jazyky	C# a Visual Basic

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ávání páru událostí, které jsou vyvolány při zavírání prostředku, je můžete pojmenovat jako "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žil přítomný nebo minulý čas slovesa.

Example

public class Session
{
    // This code violates the rule.
    public event EventHandler? BeforeClose;
    public event EventHandler? AfterClose;

    // This code satisfies the rule.
    public event EventHandler? Closing;
    public event EventHandler? Closed;
}

Kdy potlačit upozornění

Nepotlačujte upozornění na toto pravidlo.