Java project development naming convention (power node arrangement)

The purpose of defining this specification is to make all documents in the project look like they were written by one person, increase readability, and reduce losses caused by substitutions in the project team. Let me share with you the Java development naming convention, let’s take a look at it

It is best to use English, not Chinese Pinyin

1: Package ( package): Used to classify classes that complete different functions and place them in different directories (packages). The naming rule of the package: reverse the company domain name as the package name. For example, www.bjpowernode.com For package names: each letter needs to be lowercase. For example: com. bjpowernode.test; the full name of the Test class under this package is: com. bjpowernode.Test.java. If a package is not used when defining a class, Java will think that the class we defined is in the default package.

2: Class: The first letter is capitalized. If a class consists of multiple words, then the first letter of each word is capitalized, and no connectors are used in the middle. Use English as much as possible. For example, ConnectionFactory

3: Method: The first word is all lowercase. If a method consists of multiple words, then the first letter is capitalized starting from the second word, and no connector is used. addPerson

4: Attribute: Same as method. For example, ageOfPerson

5: Constant: The letters of all words are capitalized. If there are multiple words, just use underline links.

Such as:

public static final int AGE_OF_PERSON = 20; //通常加上static

Supplement: Pay attention to the following points when naming variables:

·Choose meaningful names, making sure to capitalize the first letter of each word.

· Do not use the same variable to represent two values ​​with different meanings in a function.

· i, j, k, etc. are only used as loop index variables for small loops.

· Avoid using Flag to name state variables.

· Use Is to name logical variables, such as: blnFileIsFound. By naming Boolean variables in a positive manner, other developers can more clearly understand the meaning of Boolean variables.

· If necessary, append a calculation qualifier at the end of the variable, such as: curSalesSum.

· The names are not inclusive, curSales and curSalesSum.

· The names of static final variables (constants) should be capitalized and the full meaning should be indicated.

· If you need to abbreviate the variable name, you must pay attention to the consistency of the abbreviation rules throughout the code. For example, if you use intCnt in some areas of your code and intCount in other areas, you will add unnecessary complexity to your code. It is recommended that abbreviations should be avoided in variable names.

· By placing a quantifier at the end, you create more uniform variables that are easier to understand and easier to search. For example, use strCustomerFirst and strCustomerLast instead of strFirstCustomer and strLastCustomer. Commonly used quantifier suffixes are: First (the first in a group of variables), Last (the last in a group of variables), Next (the next variable in a group of variables), Prev (previous variable in a group of variables), Cur (current variable in a group of variables).

· Select the best data type for each variable, which can reduce the memory requirements, speed up code execution, and reduce the possibility of errors. The data type used for a variable may affect the results of calculations performed on that variable. In this case, the compiler does not generate a runtime error, it simply forces the value to conform to the data type requirements. These types of issues are extremely difficult to find.

· Try to narrow the scope of variables. If a variable's scope is larger than it should be, the variable can continue to exist and occupy resources long after the variable is no longer needed. The main problem with them is that they can be modified by any method in any class, and it is difficult to track exactly where the modification was made. Occupying resources is an important issue involved in scope. For variables, keeping the scope as small as possible will have a huge impact on the reliability of the application.

Regarding the naming method of constants, in JAVA code, it is recommended to use constants to replace numbers and fixed strings at any time. In other words, except for 0 and 1, other numbers should not appear in the program as much as possible. Constants can be defined at the beginning of the program or in a wider scope. The names should be in uppercase letters and indicate the full meaning of the constant. If a constant name consists of multiple words, the words should be separated by underscore "_" such as: NUM_DAYS_IN_WEEK, MAX_VALUE.

The above is the detailed content of Java project development naming convention (power node arrangement). For more information, please follow other related articles on the PHP Chinese website!