java命名規範

一，java文件命名規範

　　1.包名（package）

　　　　命名必須所有使用英文小寫字母，禁止使用「下劃線」等字符。（除常量外，Java命名習慣中均不推薦使用下劃線等字符）

　　　　項目包命名規則：<域名反轉>.<團隊名>.<項目名>。相關項目可以使用<域名反轉>.<團隊名>.<父項目名>.<子項目名>的命名法則。

　　2.Class/Object、Interface

　　　　類和接口使用大駝峯命名法

　　　　抽象類使用「Abstract」作爲類命名的開頭

　　　　Exception類命名使用「Exception」作爲類命名的結尾

　　　　Test類使用「Test」作爲類命名的結尾

 

　　　　在面向接口編程中，接口的實現類的命名規則爲：<接口名>+"Impl"。禁止使用匈牙利命名法。

　　　　示例（正確）：

接口	實現類
HandsomeProvider	HandsomeProviderImpl

 

 

 

 

匈牙利命名法（不推薦）：

接口	實現類
IHandsomeProvider	HandsomeProvider

 

 

 

　　3.Method/Function

 

　　　　方法的命名使用駝峯法，通常使用動詞或動詞+名詞組合。

 

　　　　設置/獲取某個值的方法，命名爲setV/getV

 

　　　　返回長度的方法，命名爲length

 

　　　　判斷布爾值的方法，命名爲isV

 

　　　　將對象轉換爲某個特定類型的方法應該命名爲toT

　　4.變量的命名

　　　　第一個單詞的首字母小寫，其後單詞的首字母大寫 例如：maxValue。
　　　　變量名不該如下劃線或美圓符號開頭，儘管這在語法上是容許的。變量名應簡短且富於描述。變量名的選用應該易於記憶，即，可以指出其用途。儘可能避免單個字符的變量名，除非是一次性的臨時變量。
　　　　pojo中的布爾變量，都不要加is(數據庫中的布爾字段全都要加 is_ 前綴)。

　　5.常量/枚舉值的命名規範

　　　　常量名/枚舉值應該都使用大寫字母，下劃線分割單詞。
　　　　例如：MAX_VALUE

二，數據庫命名規範

　　表名和字段名字必須用小寫字母或數字，數字不可開頭，兩個下劃線中間不能只有數字。
　　庫名與應用名儘可能一致。
　　表名：業務名稱_表的做用(單數形式)。
　　主鍵索引：pk_字段名。
　　惟一索引：uk_字段名。
　　普通索引：idx_字段名。
　　表示是否字段：is_xxxx unsigned tinyint(1.表示是，0.表示否)。
　　觸發器：trg_表名_[ insert | update | delete ]
　　視圖：viw_相關表名1_相關表名2_...
　　數據庫禁止用存儲過程。

三，版本工具提交信息規範

　　第1行：提交修改內容的摘要(少於25個漢字，或英文大寫字母開始，不加句號，使用祈使句)。
　　第2行：空行
　　第3行及之後：修改的理由(36個漢字左右換行，正文解釋是什麼和爲何，而不是如何作)。

原文地址：http://www.javashuo.com/article/p-xqlcffur-ct.html，http://www.javashuo.com/article/p-bwxsklby-bd.html