Skip to Content

Changes for page Expressive Names

Last modified by chrisby on 2023/11/18 17:45
From version 2.5
edited by chrisby
on 2023/11/18 17:44
Change comment: There is no comment for this version
To version 2.6
edited by chrisby
on 2023/11/18 17:45
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -25,5 +25,6 @@
25 25  * **Avoid mental mappings.** The name of a variable should not require mental effort to understand. For example, unusual abbreviations should be avoided.
26 26  * **No puns or humorous names.**
27 27  * **Avoid ambiguities** such as the word "add", which could have the meaning of "addition" or " adding".
28 -* **Make differences clear** by avoiding very similar expressions and redundant empty words (a, an, the, info, data).
28 +* **Avoid very similar expressions** to make differences clear.
29 +* **Avoid redundant empty words** (a, an, the, info, data).
29 29  * **Do not add unnecessary context.** Shorter names are better than longer ones, as long as they are clear.