Skip to content

Commit

Permalink
Updated type naming examples (dennisdoomen#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
bkoelman authored and mapfel committed Mar 22, 2021
1 parent ceae484 commit ef33976
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Src/Guidelines/1700_NamingGuidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ For example, use `OnButtonClick` rather than `OnBtnClick`. Avoid single characte
- Identifiers that refer to a collection type should have plural names.

### <a name="av1708"></a> Name types using nouns, noun phrases or adjective phrases (AV1708) ![](images/2.png)
Bad examples include `SearchExamination` (a page to search for examinations), `Common` (does not end with a noun, and does not explain its purpose) and `SiteSecurity` (although the name is technically okay, it does not say anything about its purpose). Good examples include `BusinessBinder`, `SmartTextBox`, or `EditableSingleCustomer`.
For example, the name IComponent uses a descriptive noun, ICustomAttributeProvider uses a noun phrase and IPersistable uses an adjective.
Bad examples include `SearchExamination` (a page to search for examinations), `Common` (does not end with a noun, and does not explain its purpose) and `SiteSecurity` (although the name is technically okay, it does not say anything about its purpose).

Don't include terms like `Utility` or `Helper` in classes. Classes with names like that are usually static classes and are introduced without considering object-oriented principles (see also AV1008).

Expand Down

0 comments on commit ef33976

Please sign in to comment.