Java規範推薦#
推薦：http://blog.csdn.net/tristansmile/article/details/7989670
命名規範
- 項目名:全部小寫
- Package 的命名：應該都是由一個小寫單詞組成
- Class 的命名：首字母大寫的駝峰式命名，即FirstName
- 變量和方法的命名:首字母小寫的駝峰式命名，即firstName
-
當要差別接口類和實作類的時候，可以在類的後面加上“Impl”。
如：接口類：UserInterface.java 接口實作類：UserInterfaceImp
- Static Final 常量的命名:大寫下劃線形式，即FIRST_NAME
- 在Spring Boot的配置檔案application.yml或application.properties中，推薦：first-name
- 在資料庫的列中，推薦：first_name
- jsp，Velocity等頁面采用小寫的英文字元和”_ ”組成，整體采用子產品名+操作的形式。如：user_view.jsp。
- xml配置檔案很多用_.xml的方式，但我看的項目卻用mybatis-config.xml，是以暫時不統一。
名稱隻能由字母、數字、下劃線、$符号組成，不要用拼音命名
應用系統中經常應用分層，Dao層（資料庫通路）、Service層（業務處理）、Web層（頁面控制action類），每一層的類的名稱盡量帶上該層字尾。
推薦實體類沒有字尾名。
比如：
Dao層
a、接口類：采用JavaBean+Interface+Dao的形式來定義,即，實體對象+Interface+Dao。 如：使用者對象接口類： UserInterfaceDao，其中xxx為子產品名稱。
b、實作類：采用JavaBean+Interface+Impl+Dao的形式來定義,即，實體對象 +Interface+Impl+Dao。 如：使用者對象實作類：UserInterfaceImplDao
若沒有Interface，則省略
Service層
a、接口類：采用Xxx+Interface+Service的形式來定義,即，子產品+Interface+Service。 如：使用者管理接口類：UserMsgInterfaceService
b、實作類：采用Xxx+Interface+Impl+Service的形式來定義,即，子產品+Interface+Impl+Service。如：使用者管理實作類：UserMsgInterfaceImplServce
變量命名實際應用
變量命名采用基本結構為typeVariableName，使用3字元字首來表示資料類型。
例如，定義一個整形變量：intDocCount，其中int表明資料類型，後面為表意的英文名，每個單詞首字母大寫。
| 資料類型或對象類型 | 變量字首 | 備注 |
|---|---|---|
| byte | bye | 1、做數組用時，再加字首-a,如字元串數組：astr， |
| char | chr | 2、自定義類型的變量可以采用本身的名稱，把首字母改為小寫。 |
| float | flt | 3、采用名稱要能代表在方法中的意義。如果員工清單：employeeList |
| boolean | bln | |
| Integer/int | int | |
| short | sht | |
| Long/long | lng | |
| Double/double | dbl | |
| string | str |
如果需要對變量名進行縮寫時，一定要注意整個代碼中縮寫規則的一緻性。例如，如果在代碼的某些區域中使用intCnt，而在另一些區域中又使用intCount，就會給代碼增加不必要的複雜性。建議變量名中盡量不要出現縮寫。
資料層方法：隻能以insert（插入）,delete（删除）,update（更新）,select（查找）,count（統計）開頭，其他層方法避免以這個5個單詞開頭，以免造成誤解。
服務層方法，根據方法的行為命名，隻描述方法的意義，而不采用方法的目的命名。比如系統的添加新使用者，使用者可以前台注冊，也可以管理者背景添加，方法會被重用，是以最好不要用使用register，采用add會更好寫。避免使用與web層相關的方法。
Web層方法最好是貼近web的語言，如register，login，logout等方法。
注釋規範
1. 類注釋
在每個類前面必須加上類注釋，注釋模闆如下：
/**
* 類的詳細說明
*
* @author ${USER}
* @Date ${DATE}
* @version 1.00
*/
在IntelliJ IDEA中實作：
2. 方法注釋
在每個方法前面必須加上方法注釋，注釋模闆如下：
/**
* 類方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @return 傳回結果的說明
* @throws 異常類型.錯誤代碼 注明從此類方法中抛出異常的說明
*/
使用IntelliJ IDEA的Live Templates功能：
如上圖所示，點選右側的+，建立Live Template，然後編輯如上圖，将應用範圍設為Java，如果隻設comment，無法智能提示，且必須/*再按tab才行。如果有一些
$var$
,可以 編輯變量
在IntelliJ IDEA中，打出的部分就會智能提醒，Enter後恩Tab即可。
3. 屬性注釋
在每個屬性前面必須加上屬性注釋，注釋模闆如下：
/** 提示資訊 */
private String strMsg = null;
4. 構造方法注釋
在每個構造方法前面必須加上注釋，注釋模闆如下：
/**
* 構造方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @throws 異常類型.錯誤代碼 注明從此類方法中抛出異常的說明
*/
5. 方法内部注釋
在方法内部使用單行或者多行注釋，該注釋根據實際情況添加。
如：
//背景顔色
Color bgColor = Color.RED
作者：何必等明天
出處：http://www.cnblogs.com/xzwblog/
歡迎轉載，但未經作者同意必須保留此段聲明，否則保留追究法律責任的權利.