Java Project naming specification (concise version)--high salary must see

As a good project manager or project leader, must develop the good excellent project naming rules and the custom. Next, you'll sort through the data you've found, and in fact, in many projects, follow the rules below.

I. Name of the project

All lowercase, such as CMS, Workdesk,jobserver, etc.

Second, Java-related naming
A, class naming: The first letter in front of each syllable word capitalization, such as fieldinfo, expression, etc. \
b, ordinary variables (including the name of a variable reference in spring): lowercase before the first word, capitalized in the first letter of each word, password,primaryflag
c, static variables: All uppercase, multiple words separated by _, such as Boolean_flag
D, package packages named: All lowercase, such as Com.joinspider.workdesk

Add:
A, the class name, the variable name is the name combination, the multi-noun order is same as the Chinese order, for example ScriptEngine
b, attributes can also be adjectives + nouns
C, constants can use the above rules, if in order to reflect a number of constants is a set of concepts, can also be decorated with the predecessor,
For example: Var_start,var_end.
C, method is verb + name or only verb

Third, attribute file. Properties Define variable Name
Object.a_b_c format, all lowercase, where object is the host, A_b_c multiple word underscores apart.
Example: Hibernate.cache.use_second_level_cache,hibernate.cache.provider_class,hibernate.cache.provider_configuration _file_resource_path

Iv. Naming of XML files
All lowercase,-the symbol is the use of its XML description, similar to the applicationcontext is customary naming. such as Springmvc-servlet.xml, Workdesk-manager.xml, Workdesk-servlet.xml, applicationcontext-basic.xml, etc.
XML content multiple words putting-separated, such as param-name,filter-mapping, etc.

V. Common file naming (jsp,js,img, etc.)
Same as Java normal variable specification
The properties file is separated by an underscore: errors_zh_cn.properties,hibernate_test.properties

Six, database naming:

Table, field name all uppercase, multiple words separated by _

Additional 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.

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 annotations

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 comments

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

/** Tip Information */

Private String STRMSG = null;

3. Method notes

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 Annotation

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

Java Project naming specification (concise version)--high salary must see