命名規范與規則

 

命名規范

 

1、項目名全部小寫，就是如果項目名是多個英語單詞組成的，每個單詞都要全部小寫。

如：doubanssm。

2、包名全部小寫。

3、類名首字母大寫，若類名由多個單詞構成，每個單詞首字母大寫，即大駝峰命名

public class HelloWorld(){ }

4、變量名、方法名首字母小寫，若其由多個單詞構成，除變量名首字母外的其它每個單詞首字母大寫，即小駝峰命名法

public void sayHello(){ }

String userName ="luis";

5、常量名全部大寫

如：public static final int ANIMAL_NUMBER=15;

6、實體類屬性全部小寫

 

 

命名規則

 

1、名稱只能由字母、數字、下划線、$符號組成

2、不能以數字開頭

3、名稱不能使用JAVA中的關鍵字。

4、堅決不允許出現中文及拼音命名。

 

系統命名

要求：

1、統一用英文

2、名稱不宜過長

3、全部小寫

 

注釋

 

類注釋(Class)

類注釋(Class)主要用來聲明該類用來做什么，以及創建者、創建日期版本、包名等一些信息:

/**
 * @version: V1.0
 * @author: fendo
 * @className: user
 * @packageName: user
 * @description: 這是用戶類
 * @data: 2017-07-28 12:20
 **/

 

 

方法注釋(Methods)

方法注釋(Methods)主要用來聲明該類的作用、入參、返回值、異常等信息:

/**
* @author:  fendo
* @methodsName: addUser
* @description: 添加一個用戶
* @param:  type 交易類型
* @param:  data 交易數據
* @return: String 
* @throws: 
*/

 

 

 

 

其他

 

等號兩邊要各留一個空格。