java development naming rules

1. Files

1. The suffix of the property file is properties and conforms to the i18n specification in java;
2. The configuration file of each product module must be placed in the conf directory of its own module;
3. File naming needs It has a certain meaning and should be as short as possible. The name meets the requirements of the operating system and must be composed of English or Chinese pinyin. There cannot be spaces in the file name. For ordinary files, use underscores between words.

2. Naming convention

2.1 Basic rules

1. The character set is among 26 English letters, Arabic numerals from 0 to 9, and underscores. In Java, classes, fields, methods, variables, and constants should be expressed in letters as much as possible. Any other characters cannot be used without special reasons
2. Naming needs to have a certain meaning. It is recommended to use terminology in the problem domain to make the naming more concise to a certain extent. The above is self-describing
3. Keep the name as short as possible. If the name is too long, you can use aliases or abbreviations to simplify the naming. Abbreviations must have meaning, and the meaning of these abbreviations needs to be maintained throughout the project
4. Rules for name abbreviation (applicable to class names, field names, variable names, module names, etc.)
1) Delete all original letters, Compress repeated letters. For example, button is abbreviated as btn,
2) If a naming conflict occurs, the original sound will be retained in a certain abbreviation. For example, batton, in order not to conflict with button, is abbreviated as batn
5. Do not use leading underscores, and do not use underscores at the end of the name

2.2 Constant naming rules

1. All characters must be capitalized. Use meaningful word combinations to express, and words are separated by "_" underscores.
2. Keep the name as short as possible, no more than 16 characters

It is best not to work directly with literals during program development. It is best to introduce constants for application; it can only be used in special circumstances, such as when initializing variables in a for loop. You can directly use constants like -1,0,1

Example

publicfinalintMAX_SIZE =120;
publicfinalintMAX_WIDTH =100;
publicfinalString PROPERTY_NAME="menu";

2.3 Variable naming rules

1. Avoid using numbers in naming, unless the naming meaning is clear and the program is clearer, there should not be any in the naming of instance variables Number
2. The variable name is a noun meaning
3. Use a word or word combination that has the meaning of the problem domain. The first word is all lowercase, and the first letter of each subsequent word is capitalized, and the rest is lowercase (except special words, such as URL)
4. Keep the name as short as possible, no more than 16 characters
5. Except for temporary variables with a short life cycle In addition, avoid using single characters as variable names, and do not use single characters when naming instance variables. Commonly used single character variables such as integer types use i, j, k, m, n character types use c, d, e, and coordinates use x, y, z.
6. In some cases, variables may need to be added with a type prefix. All type prefixes must be lowercase. There is no gap between them and the entity part of the variable name. Each word in the entity part has the first letter capitalized, and the remaining words Lower case (except for special words such as URL), it is strongly recommended to use global variables of the class. The general type prefix is ​​as follows

publicintwidth;
publicString fileName;
publicstaticApplicationContext context;

2.4 Method naming rules

1. Use words or word combinations that match the meaning of the problem domain. The first word is lowercase, each subsequent word is capitalized, and the rest is lowercase (except special words such as URL). There is no special reason not to use underscores as separators
2. Naming attribute methods in Java follows the JavaBean standard:
1) Getter method: get+attribute name, use is+attribute name for boolean type, some specific attribute names may be better to use has, can instead of is
2) Setter method: set+attribute name
3. Naming and class construction method The names are consistent

2.5 Class and interface naming rules

1. Use words or word combinations that match the meaning of the problem domain. The first letter of each word is capitalized and the remaining letters are lowercase (except special words such as URL)
2. The first letter of the interface One character uses Ｉ

Example

publicclassFiugre
publicinterfaceFiugreContainer
publicclassStdFigure//std为Standard的缩写

2.6 package naming rules

1. All characters in the package name are lowercase;
2. There should be no two-way dependence between two packages of different businesses, but one-way dependence;
3. Adopt a logical hierarchical structure to reduce dependencies