CA1713: Non utilizzare il prefisso Before o After negli eventi
Proprietà | valore |
---|---|
ID regola | CA1713 |
Titolo | Non usare il prefisso Before o After negli eventi |
Categoria | Denominazione |
Correzione che causa un'interruzione o un'interruzione | Interruzione |
Abilitato per impostazione predefinita in .NET 8 | No |
Causa
Il nome di un evento inizia con 'Before' o 'After'.
Descrizione regola
I nomi degli eventi devono descrivere l'azione che genera l'evento. Per denominare eventi correlati generati in una sequenza specifica, utilizzare i tempi verbali presente o passato per indicare la posizione relativa nella sequenza di azioni. Ad esempio, quando si assegna un nome a una coppia di eventi generati quando si chiude una risorsa, è possibile denominarla "Closing" e "Closed", anziché "BeforeClose" e "AfterClose".
Le convenzioni di denominazione forniscono un aspetto comune per le librerie destinate a Common Language Runtime. In questo modo si riduce la curva di apprendimento necessaria per le nuove librerie software e si aumenta la fiducia dei clienti che la libreria è stata sviluppata da un utente esperto nello sviluppo di codice gestito.
Come correggere le violazioni
Rimuovere il prefisso dal nome dell'evento e prendere in considerazione la modifica del nome in modo da usare il tempo presente o passato di un verbo.
Quando eliminare gli avvisi
Non escludere un avviso da questa regola.