Skip to content

Commit 7bd1063

Browse files
dennisdoomenDennis DoomenCopilot
authored
Update AV1708 guideline (#372)
Split from #298. Co-authored-by: Dennis Doomen <dennis.doomen@greenchoice.nl> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 46c4087 commit 7bd1063

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

_rules/1708.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ rule_category: naming-conventions
44
title: Name types using nouns, noun phrases or adjective phrases
55
severity: 2
66
---
7-
For example, the name IComponent uses a descriptive noun, ICustomAttributeProvider uses a noun phrase and IPersistable uses an adjective.
7+
For example, the name `IComponent` uses a descriptive noun, `ICustomAttributeProvider` uses a noun phrase and `IPersistable` uses an adjective.
88
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).
99

1010
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 [{{ site.default_rule_prefix }}1008](/member-design-guidelines#{{ site.default_rule_prefix }}1008)).

0 commit comments

Comments
 (0)