Changes for page Expressive Names

Last modified by chrisby on 2023/11/18 17:45

From version 1.7
edited by chrisby
on 2023/11/18 16:15
Change comment: There is no comment for this version
To version 1.8
edited by chrisby
on 2023/11/18 16:19
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,18 +7,17 @@
7 7  * **Use searchable names.** Searchable means avoiding search conflicts with other similar or even identical names. The length of a name should match the size of its scope. For local counting loops, one letter is sufficient; if the variable is used in several places in the code, it needs a longer name.
8 8  * **Avoid encodings.** There should be no references to the scope or type of the variable in the name.
9 9  * **Avoid mental mappings.** The name of a variable should not require mental effort to understand. For example, unusual abbreviations should be avoided.
10 -* Names of classes consist of nouns or substantivistic expressions.
11 -* Method names
12 - * They consist of a verb or an expression with a verb. Accessors, mutators, and predicates should be named after their value and follow the JavaBean standard (prefixes: get, set, is, has).
13 - * Overloaded constructors can lead to confusion, e.g. if one constructor accepts a float argument and and another one an int argument. Overloaded constructors should be declared as private and functions should be used to create instances whose names highlight the difference.
14 -* No puns or humorous names.
15 -* Choose one word for each concept. For example, if you use the word "fetch" once for a particular concept, you should consistently use "fetch" instead of synonyms such as "retrieve".
16 -* Avoid ambiguities as in the word "add" (addition or adding).
10 +* **Names of classes consist of nouns** or substantivistic expressions.
11 +* **Method names** **consist of a verb** or an expression with a verb. Accessors, mutators, and predicates should be named after their value and follow the JavaBean standard (prefixes: get, set, is, has).
17 17  *
18 18  
19 -Domain-specific terms
14 +**Use object creation functions rather than overloaded constructors**, as the latter can cause confusion. Overloaded constructors should be declared private, and functions should be used to create instances whose names make the difference clear.
15 +* **No puns or humorous names.**
16 +* **Choose one word for each concept.** For example, if you use the word "fetch" once for a particular concept, you should consistently use "fetch" instead of synonyms such as "retrieve".
17 +* **Avoid ambiguities** as in the word "add" (addition or adding).
18 +* **Domain-specific terms**
20 20   * Use terms from the solution domain. Programmers will be reading your code, so use technical language.
21 21   * Use terms from the problem domain. If there are no computer science terms, at least domain experts can refer to them.
22 -* Add meaningful context. Together with the names of other variables and methods, this context can be created.
23 -* Do not add superfluous context. Shorter names are better than longer ones, as long as they are clear.
24 -* Dare to rename things. Your colleagues should be grateful for improvements.
21 +* **Add meaningful context.** Together with the names of other variables and methods, this context can be created.
22 +* **Do not add superfluous context.** Shorter names are better than longer ones, as long as they are clear.
23 +* **Dare to rename things.** Your colleagues should be grateful for improvements.