How do you choose meaningful and consistent names for your variables, functions, and classes?

1 Use descriptive and specific names

One of the key principles of clean code is to use names that reveal the intention and purpose of your code elements. Avoid vague, generic, or ambiguous names that could mean different things in different contexts. For example, instead of naming a variable x, name it something more meaningful like userAge, invoiceAmount, or temperatureCelsius. Similarly, instead of naming a function doSomething, name it something more specific like calculateInterest, sendEmail, or validateInput.

3 Avoid using abbreviations or acronyms

A common mistake that can make your code hard to read and understand is using abbreviations or acronyms that are not widely known or obvious. Unless the abbreviation or acronym is very common and clear, such as HTML, URL, or API, avoid using it in your names. Instead, use the full word or phrase that explains what the code element does or represents. For example, instead of naming a variable numCust, name it numberOfCustomers. Instead of naming a function calcAvg, name it calculateAverage.

4 Use consistent and meaningful prefixes and suffixes

Sometimes, you may need to use prefixes or suffixes to add more information or context to your names. For example, you may use prefixes to indicate the type, scope, or visibility of your variables, such as int, g_, or m_. You may use suffixes to indicate the unit, format, or role of your variables, such as _sec, _txt, or _btn. However, you should use prefixes and suffixes only when they are necessary and helpful, and not when they are redundant or confusing. You should also use them consistently and meaningfully throughout your code.

5 Avoid using magic numbers or strings

Another common mistake that can make your code hard to read and understand is using magic numbers or strings. Magic numbers or strings are literal values that are not explained or defined in your code. For example, instead of using 3.14, 42, or "Hello", you should use constants or variables that have meaningful names, such as PI, ANSWER, or GREETING. This way, you can avoid hard-coding values that may change or have different meanings in different situations.

6 Refactor and rename your code as needed

Finally, one of the best practices of clean code is to refactor and rename your code as needed. Refactoring is the process of improving your code without changing its functionality. Renaming is one of the simplest and most effective ways of refactoring your code. As your code evolves and grows, you may find that some of your names are no longer accurate, relevant, or consistent. In that case, you should not hesitate to change them to better reflect the current state and logic of your code.

7 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?