Naming conventions in Java projects

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.

such as: public class myfirstclass{}

4, the variable name, the method name first letter lowercase, if the name is composed of multiple words, the first letter of each word should be capitalized.

such as: int index=0;

public void ToString () {}

5, the constant name all uppercase

such as: public static final String game_color= "RED";

6. All naming rules must follow the following rules:

1), the name can only be composed of letters, numbers, underscores, $ symbols

2), cannot start with a number

3), name cannot use keywords in java.

4), not to be allowed to appear in Chinese and pinyin naming.

II. specification of annotations

1. class Comment

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

/**

* Copyright (C), 2006-2010, Chengdu Lovo Info. Co., Ltd.

* FileName:Test.java

* Detailed description of the class

*

* @author Class Creator name
* @Date Date Created

* @version 1.00

*/

2. attribute Comment

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

/** Tip Information */

Private String STRMSG = null;

3. Method Comment

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

/**

* Detailed instructions for using the class method

*

* Instructions for use of @param parameter 1 parameter 1

* @return A description of the return result

* @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:

/**

* Detailed usage instructions for the construction method

*

* Instructions for use of @param parameter 1 parameter 1

* @throws exception type. The error code indicates 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.

such as://Background color

Color BgColor = color.red

Naming conventions in Java projects