CA1713: Events should not have before or after prefix
Note
This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here
| Item | Value |
|---|---|
| TypeName | EventsShouldNotHaveBeforeOrAfterPrefix |
| CheckId | CA1713 |
| Category | Microsoft.Naming |
| Breaking Change | Breaking |
Cause
The name of an event starts with 'Before' or 'After'.
Rule Description
Event names should describe the action that raises the event. To name related events that are raised in a specific sequence, use the present or past tense to indicate the relative position in the sequence of actions. For example, when naming a pair of events that is raised when closing a resource, you might name it 'Closing' and 'Closed', instead of 'BeforeClose' and 'AfterClose'.
Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.
How to Fix Violations
Remove the prefix from the event name, and consider changing the name to use the present or past tense of a verb.
When to Suppress Warnings
Do not suppress a warning from this rule.