Detailed explanation of code specifications for Java development

The coding standards to be followed in Java development generally include the following 7 points. Naming specifications, comment specifications, indentation formatting specifications, file name specifications, declaration specifications, statement specifications and programming specifications. [Recommended learning: java video tutorial]

1. Naming convention

(1) All The identifiers can only use ASCⅡ letters (A-Z or a-z), numbers (0-9) and the underscore "_".

(2) The prefix of a unique package name is always all lowercase letters. For example: www.tonysun.cc

(3) The class name is a noun, using mixed case, with the first letter of each word capitalized. For example: Tony.

(4) The case rules for interfaces are similar to class names: for example: Tony.

(5) The method name is a verb or verb phrase, in mixed case, with the first letter of the first word in lowercase, and the first letter of the subsequent words in uppercase. For example: setNeekeName(String&neekeName).

(6) The first letter of the variable name is lowercase, and the first letter of any intermediate words is capitalized. Variable names should be short and easy to remember. For example: neekeName, neekeAddress. Avoid single-character variable names, except for one-time temporary variables.

(7) The declaration of constants should be in all capital letters, with "_" connecting each word. For example: final&String&WWW_TONY_CN&=&"www.tonysun.cc";

2. Comment specification

(1) Use comments as much as possible "//"; use "/**&*/" for all javadoc comments; and try to use "/*&*/" for temporary comments on code blocks.

(2) All source files should have a comment at the beginning listing the file name, date and a functional overview of the class.

(3) Documentation comments must be added to each method (except the main() method of the class).

(4) Each attribute must be commented.

(5) The code contains at least 15% comments.

(6) Comments are in Chinese.

3. Indentation typesetting specifications

(1) Avoid a line longer than 60 characters.

(2) Use the source code formatting function of Eclipse to complete the indentation of the code (Ctrl Shift F).

4. File name specifications

(1) A Java source file can only store one Java class.

(2) The file name is the same as the Java class name.

(3) The code lines of a class file shall not exceed 200 lines.

5. Declaration specifications

(1) Declare a variable in one line.

(2) Do not put declarations of variables of different types on the same line.

(3) Only declare variables at the beginning of the code block.

(4) All variables must be initialized when declared.

(5) Avoid declared local variables from overwriting variables declared at the previous level.

(6) Methods are separated by blank lines.

6. Statement specifications

(1) Each line contains at least one simple statement.

(2) In the return statement, the return value is not enclosed in parentheses "()".

(3) If statements are always enclosed in "{" and "}".

(4) In the initialization or update clause of the for statement, avoid increasing the complexity caused by using more than three variables.

(5) When a case of switch is executed downwards (because there is no break statement), comments should usually be added at the location of the break statement.

7. Programming specifications

(1) Provide public or private access control to instances and class variables, and do not apply default values ​​or protected access control as much as possible.

(2) Avoid using an object to access static variables or methods of a class. Class names should be used instead.

(3) Avoid assigning the same value to multiple variables in one statement.

(4) Use switch() statement to implement multi-way branches.

(5) If you use JDBC, consider using java.sql.PreparedStatement instead of java.sql.Statement.

(6) The prefix of the method used to set the state of the object must be set; the prefix of the method used to retrieve the state of a Boolean type object must be is, and the prefix of the method used to retrieve other methods must be get.

(7) Numbers (or characters) should be used as little as possible in the program, and static variables should be defined as much as possible to illustrate the meaning of the numbers (or characters). When assignment or comparison is required in the program, use the static variables defined previously. Exception in loop control.

This article comes from the java introduction column, welcome to learn!

The above is the detailed content of Detailed explanation of code specifications for Java development. For more information, please follow other related articles on the PHP Chinese website!