俗話說：“沒有規矩不成方圓”。編程工作往往都是一個團隊協同進行，因而一致的編碼規範非常有必 要，這樣寫成的代碼便於團隊中的其他人員閱讀，也便於編寫者自己以後閱讀。
下面我將列舉一些在編程中的命名注意事項。此篇文章參考《碼出高效》–阿里巴巴Java開發手冊1.4.0。
1:代碼中的命名均不能以下劃線或美元符號開始，也不能以下劃線或美元符號結束
反例：_name / name / / name
2:代碼中的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。
正例：alibaba / taobao / youku / hangzhou 等國際通用的名稱，可視同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3
3:類名使用 大駝峯法UpperCamelCase 風格，但以下情形例外：DO / BO / DTO / VO / AO /PO / UID 等。
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4:方法名、參數名、成員變量、局部變量都統一使用小駝峯法 lowerCamelCase 風格，必須遵從 駝峯形式。
正例： localValue / getHttpMessage() / inputUserId
5:常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
6:抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類
命名以它要測試的類的名稱開始，以 Test 結尾。
7:類型與中括號緊挨相連來表示數組。
正例：定義整形數組 int[] arrayDemo;
反例：在 main 參數中，使用 String args[]來定義。
8:POJO 類中布爾類型的變量，都不要加 is 前綴，否則部分框架解析會引起序列化錯誤。
反例：定義爲基本數據類型 Boolean isDeleted 的屬性，它的方法也是 isDeleted()，RPC框架在反向解析的時候，“誤以爲”對應的屬性名稱是 deleted，導致屬性獲取不到，進而拋 出異常。
9:包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用 單數形式，但是類名如果有複數含義，類名可以使用複數形式。
正例：應用工具類包名爲 com.alibaba.ai.util、類名爲 MessageUtils（此規則參考 spring 的框架結構）
10:杜絕完全不規範的縮寫，避免望文不知義。
反例：AbstractClass“縮寫”命名成 AbsClass；condition“縮寫”命名成 condi，此類隨
意縮寫嚴重降低了代碼的可閱讀性。
11:爲了達到代碼自解釋的目標，任何自定義編程元素在命名時，使用盡量完整的單詞
組合來表達其意。
正例：在 JDK 中，表達原子更新的類名爲：AtomicReferenceFieldUpdater。
反例：變量 int a 的隨意命名方式。
12：如果模塊、接口、類、方法使用了設計模式，在命名時需體現出具體模式。
正例：
public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
13:接口類中的方法和屬性不要加任何修飾符號（public 也不要加），保持代碼的簡潔 性，並加上有效的 Javadoc 註釋。儘量不要在接口裏定義變量，如果一定要定義變量，肯定是 與接口方法相關，並且是整個應用的基礎常量。
正例：接口方法簽名 void commit(); 接口基礎常量 String COMPANY = “alibaba”;
反例：接口方法定義 public abstract void f();
14:接口和實現類的命名有兩套規則：
（1）對於 Service 和 DAO 類，基於 SOA 的理念，暴露出來的服務一定是接口，內部 的實現類用 Impl 的後綴與接口區別。
正例：CacheServiceImpl 實現 CacheService 接口。
（2）如果是形容能力的接口名稱，取對應的形容詞爲接口名（通常是–able 的形式）。
正例：AbstractTranslator 實現 Translatable 接口。
15:枚舉類名建議帶上 Enum 後綴，枚舉成員名稱需要全大寫，單詞間用下劃線隔開。
正例：枚舉名字爲 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON。
16:各層命名規約：
A) Service/DAO 層方法命名規約
1） 獲取單個對象的方法用 get 做前綴。
2） 獲取多個對象的方法用 list 做前綴，複數形式結尾如：listObjects。
3） 獲取統計值的方法用 count 做前綴。
4） 插入的方法用 save/insert 做前綴。
5） 刪除的方法用 remove/delete 做前綴。
6） 修改的方法用 update 做前綴。
B) 領域模型命名規約
1） 數據對象：xxxDO，xxx 即爲數據表名。
2） 數據傳輸對象：xxxDTO，xxx 爲業務領域相關的名稱。
3） 展示對象：xxxVO，xxx 一般爲網頁名稱。
4） POJO 是 DO/DTO/BO/VO 的統稱，禁止命名成 xxxPOJO。
以上內容僅供參考學習，如有侵權請聯繫我刪除！
如果這篇文章對您有幫助，左下角的大拇指就是對博主最大的鼓勵。
您的鼓勵就是博主最大的動力！