CA1713: Ereignisse sollten kein Before- oder After-Präfix aufweisen.

Eigenschaft	Wert
Regel-ID	CA1713
Titel	Ereignisse sollten kein Before- oder After-Präfix aufweisen.
Kategorie	Benennung
Fix führt oder führt nicht zur Unterbrechung	Breaking
Standardmäßig in .NET 10 aktiviert	No

Ursache

Der Name eines Ereignisses beginnt mit Before oder After.

Regelbeschreibung

Ereignisnamen sollten die Aktion beschreiben, durch die das Ereignis ausgelöst wird. Um verwandte Ereignisse zu benennen, die in einer bestimmten Reihenfolge ausgelöst werden, verwenden Sie die Gegenwarts- oder Vergangenheitsform, um ihre relative Position in der Aktionsfolge anzugeben. Ein Ereignispaar, das beim Schließen einer Ressource ausgelöst wird, sollte „Schließen“ oder „Geschlossen“ genannt werden, nicht „VorDemSchließen“ oder „NachDemSchließen“.

Durch Benennungskonventionen erhalten Bibliotheken, die auf die Common Language Runtime abzielen, ein einheitliches Erscheinungsbild. Dadurch wird der Lernaufwand für neue Softwarebibliotheken verringert. Zudem wird das Kundenvertrauen dahingehend gestärkt, dass die Bibliothek von einem erfahrenen Entwickler für verwalteten Code erstellt wurde.

Behandeln von Verstößen

Entfernen Sie das Präfix aus dem Ereignisnamen, und ändern Sie ggf. den Namen so, dass das Verb in der Gegenwarts- oder Vergangenheitsform verwendet wird.

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;
}

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie keine Warnung dieser Regel.