Java Naming conventions

First, naming norms

1, the project name all lowercase

2. Package name All lowercase

3. The first letter of the class name is capitalized, if the class name consists of multiple words, the first letter of each word is capitalized.

 Public class myfirstclass{}

4, the variable name, the method name lowercase, if the name consists of multiple words, in addition to the first word of each word of the first letter is capitalized.

/***/int index=0; /**  */publicvoid toString () {}

5, the constant name all uppercase

 Public Static Final String game_color= "RED";

6. All naming rules must follow the following rules:

• Names can only consist of letters, numbers, underscores, and $ symbols
• Cannot start with a number
• The name cannot use keywords in java.
• The Chinese and pinyin names should never be allowed to appear.

II. specification of annotations

1. class Comment

You must precede each class with a class comment, and the comment template is as follows:

/**@author  class creator name    * @Date@version  1.00 */

2. attribute Comment

You must precede each property with a property comment, and the comment template is as follows:

/***/privatenull;

3. Method Comment

You must add a method comment before each method, and the comment template is as follows:

/**@param@return@throws  exception type. The error code indicates the description of the exception thrown from such a method */

4. Construction Method Comments

You must precede each construction method with a comment, with the following comment template:

/**@param@throws  exception type. The error code notes the description of the exception thrown from such a method * /

5. Method Internal Comment

Use a single-line or multiline comment inside the method, which is added according to the actual situation.

// Background Color  = color.red

Reprinted from Https://www.cnblogs.com/maowang1991/archive/2013/06/29/3162366.html

Java Naming conventions