Skip to content

Commit 001b220

Browse files
bkoelmanmapfel
authored andcommitted
Updated to include local functions (dennisdoomen#117)
* Updated to include local functions * caps
1 parent 610c024 commit 001b220

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

Src/Cheatsheet/Cheatsheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ NOTE: Requires Markdown Extra. See http://michelf.ca/projects/php-markdown/extra
168168
* Name types using nouns, noun phrases or adjective phrases (AV1708)
169169
* Don’t repeat the name of a class or enumeration in its members (AV1710)
170170
* Avoid short names or names that can be mistaken with other names (AV1712)
171-
* Name methods using verb-object pair (AV1720)
171+
* Name methods and local functions using verbs or verb-object pairs (AV1720)
172172
* Name namespaces using names, layers, verbs and features (AV1725)
173173
</td>
174174
<td class="column">

Src/Guidelines/1700_NamingGuidelines.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,10 @@ Although technically correct, statements like the following can be confusing:
9696
- Consider prefixing boolean properties with `Is`, `Has`, `Can`, `Allows`, or `Supports`.
9797
- Consider giving a property the same name as its type. When you have a property that is strongly typed to an enumeration, the name of the property can be the same as the name of the enumeration. For example, if you have an enumeration named `CacheLevel`, a property that returns one of its values can also be named `CacheLevel`.
9898

99-
### <a name="av1720"></a> Name methods using a verb or a verb-object pair (AV1720) ![](images/2.png)
100-
Name methods using a verb like `Show` or a verb-object pair such as `ShowDialog`. A good name should give a hint on the *what* of a member, and if possible, the *why*.
99+
### <a name="av1720"></a> Name methods and local functions using verbs or verb-object pairs (AV1720) ![](images/2.png)
100+
Name a method or local function using a verb like `Show` or a verb-object pair such as `ShowDialog`. A good name should give a hint on the *what* of a member, and if possible, the *why*.
101101

102-
Also, don't include `And` in the name of a method. It implies that the method is doing more than one thing, which violates the single responsibility principle explained in AV1115.
102+
Also, don't include `And` in the name of a method or local function. That implies that it is doing more than one thing, which violates the Single Responsibility Principle explained in AV1115.
103103

104104
### <a name="av1725"></a> Name namespaces using names, layers, verbs and features (AV1725) ![](images/3.png)
105105
For instance, the following namespaces are good examples of that guideline.

0 commit comments

Comments
 (0)