How Programmers Name Variables

When writing code, naming variables is very important. Good naming habits can improve the readability and maintainability of your code, making it easier for other developers to understand your code. In this article, we'll discuss how programmers can choose appropriate names for variables.

specification

First of all, you need to understand the naming convention of the programming language and project used. Different programming languages and teams may have different naming conventions. For example, Python typically uses underscores to separate words ( snake_case), while Java and JavaScript prefer camel case ( camelCase). Following consistent naming rules will make the entire code base more uniform and reduce learning costs.

See the name and know the meaning

A good variable name should be as descriptive as possible of what it actually represents. In other words, when other developers see the variable name, they should be able to guess what it means and how it is used.

good example

user_namestands for username;
password_hashRepresents the hashed password;
email_listis a mailing list.

bad example

x, y, zsuch a simple letter name cannot reflect the actual meaning of the variable (unless in specific scenarios, such as coordinates or mathematical formulas);
temp, dataetc. are too generalized to directly understand their use;
string1, array2only provides data type information, but does not explain its purpose.

avoid verbosity

While variable names should be descriptive, lengthy names need to be avoided at the same time. Names that are too long can make code difficult to read and maintain. Often, it is preferable to choose a concise and unambiguous combination of words.

good example

index
user_count

bad example

the_index_of_the_current_element_in_the_list
the_total_number_of_users_in_the_database

use terminology

If you are writing code that involves knowledge of a certain domain, you can use the professional term of the domain as the variable name. This will make it easier for developers with a good understanding of the domain to understand the intent of your code.

good example

In the field of computational geometry, the variable name centroidrepresents the centroid of the polygon;
In cryptography, variable names saltrepresent extra values mixed in when encrypting.

handle plurals

It is best to use plural names when the variable contains a series of objects. This lets the reader know that it's a collection type (like list, array, set, etc.) and not just containing a single object.

good example

users
files

Avoid duplicate and similar names

To improve code readability, try to avoid using similar or confusing variable names in the same scope.

bad example

user_listand users_list;
convert_to_stringand transform_to_string.

in conclusion

Good naming conventions are crucial to writing high-quality code. Make sure the variable names you choose are concise, descriptive, and follow project specifications. This will make it easier for other developers to understand and maintain your code.