CA1713: Ereignisse sollten kein Before- oder After-Präfix aufweisen
TypeName |
EventsShouldNotHaveBeforeOrAfterPrefix |
CheckId |
CA1713 |
Kategorie |
Microsoft.Naming |
Unterbrechende Änderung |
Breaking |
Ursache
Der Name eines Ereignisses beginnt mit "Before" oder "After".
Regelbeschreibung
Ereignisnamen sollten die Aktion beschreiben, die das Ereignis auslöst. 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. Wenn Sie z. B. ein Paar von Ereignissen benennen, die beim Schließen einer Ressource ausgelöst werden, nennen Sie es "Closing" und "Closed" anstelle von "BeforeClose" und "AfterClose".
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 vom Ereignisnamen, und erwägen Sie eine Namensänderung und die Verwendung der Gegenwarts- oder Vergangenheitsform eines Verbs.
Wann sollten Warnungen unterdrückt werden?
Unterdrücken Sie keine Warnung dieser Regel.