CA1713: Gebeurtenissen mogen niet vóór of na voorvoegsel hebben

Eigenschap Waarde
Regel-id CA1713
Titel Gebeurtenissen mogen niet vóór of na voorvoegsel hebben
Categorie Naamgeving
Fix kan brekend of niet-brekend zijn Onderbreking
Standaard ingeschakeld in .NET 10 Nee
Toepasselijke talen C# en Visual Basic

Oorzaak

De naam van een gebeurtenis begint met 'Voor' of 'Na'.

Beschrijving van regel

Namen van gebeurtenissen moeten de actie beschrijven waarmee de gebeurtenis wordt gegenereerd. Als u gerelateerde gebeurtenissen wilt noemen die in een specifieke volgorde voorkomen, gebruikt u de tegenwoordige of verleden tijd om de relatieve positie in de reeks van acties aan te geven. Als u bijvoorbeeld een paar gebeurtenissen noemt die worden gegenereerd bij het sluiten van een resource, kunt u deze de naam 'Sluiten' en 'Gesloten' geven in plaats van 'BeforeClose' en 'AfterClose'.

Naamconventies zorgen voor een eenduidige uitstraling voor bibliotheken die gericht zijn op de Common Language Runtime (CLR). Dit vermindert de leercurve die vereist is voor nieuwe softwarebibliotheken en verhoogt het vertrouwen van klanten dat de bibliotheek is ontwikkeld door iemand die expertise heeft in het ontwikkelen van beheerde code.

Hoe schendingen op te lossen

Verwijder het voorvoegsel uit de gebeurtenisnaam en overweeg de naam te wijzigen om de huidige of eerdere tijd van een werkwoord te gebruiken.

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

Wanneer waarschuwingen onderdrukken

Een waarschuwing van deze regel niet onderdrukken.