摘要:一命名規(guī)則類名和接口使用意義完整的英文描述,每個英文單詞的首字母使用大寫其余字母使用小寫的大小寫混合法。在內部規(guī)劃好包名的范圍,防止產(chǎn)生沖突。示例常量名使用全大寫的英文描述,英文單詞之間用下劃線分隔開,并且使用修飾。
一 命名規(guī)則
類名和接口使用意義完整的英文描述,每個英文單詞的首字母使用大寫、其余字母使用小寫的大小寫混合法。
示例:
OrderInformation, CustomerList, LogManager, LogConfig, SmpTransaction
方法名使用意義完整的英文描述:第一個單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法。
示例:
private void calculateRate(); public void addNewOrder();
包名采用域名倒置加上自定義的包名,采用小寫字母。在內部規(guī)劃好包名的范圍,防止產(chǎn)生沖突。部門內部產(chǎn)品使用部門名加上模塊名稱。產(chǎn)品線的產(chǎn)品使用產(chǎn)品的名稱加行模塊的名稱
格式:
com.dmall.產(chǎn)品名.模塊名 com.dmall.部門名稱.項目名稱
示例:
商品系統(tǒng)lighthouse:com.dmall.ware.lighthouse 通用消息:com.dmall.dafka
方法中,存取屬性的方法采用setter 和 getter方法,動作方法采用動詞和動賓結構。
格式:
get + 非布爾屬性名() is + 布爾屬性名() set + 屬性名() 動詞() 動詞 + 賓語()
示例:
public String getType(); public boolean isFinished(); public void setVisible(boolean); public void show(); public void addKeyListener(Listener);
屬性名使用意義完整的英文描述,第一個單詞的字母使用小寫,剩余單詞首字母大寫其余字母小寫的大小寫混合法。屬性名不能與方法名相同。
示例:
private customerName; private orderNumber;
常量名使用全大寫的英文描述,英文單詞之間用下劃線分隔開,并且使用 static final修飾。
示例:
private static final int PAGE_COUNT = 1000; private static final Logger LOGGER = LoggerFactory.getLogger(CacheControlServiceImpl.class); public static final String DEFAULT_START_DATE = "2001-12-08";
屬性名可以和公有方法參數(shù)相同,不能和局部變量相同,引用非靜態(tài)變量。
抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結尾;測試類 命名以它要測試的類的名稱開始,以 Test 結尾;枚舉用Enum結尾。
如果使用到了設計模式,建議在類名中體現(xiàn)出具體模式。
示例:
public class OrderFactory; public class LoginProxy; public class ResourceObserver;
通過對函數(shù)或過程、變量、結構等正確的命名以及合理地組織代碼的結構,使代碼成為自注釋的。增加代碼的可讀性,減少不必要的注釋。
常用組件類的命名以組件名加上組件類型名結尾。
示例:
Application 類型的,命名以App 結尾——MainApp Frame 類型的,命名以Frame 結尾——TopoFrame Panel 類型的,建議命名以Panel 結尾——CreateCircuitPanel Bean 類型的,建議命名以Bean 結尾——DataAccessBean EJB 類型的,建議命名以EJB 結尾——DBProxyEJB Applet 類型的,建議命名以Applet 結尾——PictureShowApplet
如果函數(shù)名超過15 個字母,可采用以去掉元音字母的方法或者以行業(yè)內約定俗成的縮寫方式縮寫函數(shù)名。
示例:
getCustomerInformation() 改為 getCustomerInfo()
接口和實現(xiàn)類的命名規(guī)則
對于 Service 和 DAO 類,基于 SOA 的理念,暴露出來的服務一定是接口,內部
的實現(xiàn)類用 Impl 的后綴與接口區(qū)別。
示例:
CacheServiceImpl 實現(xiàn) CacheService 接口。
如果是形容能力的接口名稱,取對應的形容詞做接口名(通常是–able 的形式)。 示例:
AbstractTranslator 實現(xiàn) Translatable。
long 或者 Long 初始賦值時,必須使用大寫的 L,不能是小寫的 l,小寫容易跟數(shù)字 1 混淆,造成誤解。
示例:
Long a = 2l; 寫的是數(shù)字的21,還是Long型的2?
15.不要使用一個常量類維護所有常量,應該按常量功能進行歸類,分開維護。如:緩存 相關的常量放在類:CacheConsts 下;系統(tǒng)配置相關的常量放在類:ConfigConsts 下
各層命名規(guī)范
1)Service/DAO層方法命名規(guī)約
獲取單個對象的方法用get做前綴。
獲取多個對象的方法用list做前綴。
獲取統(tǒng)計值的方法用count做前綴。
插入的方法用save(推薦)或insert做前綴。
刪除的方法用remove(推薦)或delete做前綴。
修改的方法用update做前綴。
2)領域模型命名規(guī)約
數(shù)據(jù)對象:xxxDO,xxx即為數(shù)據(jù)表名。
數(shù)據(jù)傳輸對象:xxxDTO,xxx為業(yè)務領域相關的名稱。
展示對象:xxxVO,xxx一般為網(wǎng)頁名稱。
POJO是DO/DTO/BO/VO的統(tǒng)稱,禁止命名成xxxPOJO。
文章版權歸作者所有,未經(jīng)允許請勿轉載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉載請注明本文地址:http://m.specialneedsforspecialkids.com/yun/70159.html
摘要:此處指定的虛擬機與平臺兼容,并支持語言規(guī)范中指定的編程語言。第章說明了虛擬機的指令集,按字母順序顯示操作碼助記符。 介紹 一點歷史 Java?編程語言是一種通用的、并發(fā)的、面向對象的語言,它的語法類似于C和C++,但它省略了許多使C和C++復雜、混亂和不安全的特性。最初開發(fā)Java平臺是為了解決為聯(lián)網(wǎng)的消費者設備構建軟件的問題,它旨在支持多種主機架構,并允許安全交付軟件組件,為了滿足這...
摘要:最近在看一本有關編程規(guī)范的書,書中精煉闡述了使用語言時應該遵循的一些原則。所以擁有良好一致的編程規(guī)范對于一個團隊至關重要。二堅持最小驚奇原則在編碼過程中盡量避免可能讓軟件用戶感到意外的做法。 最近在看一本有關Java編程規(guī)范的書,書中精煉闡述了使用java語言時應該遵循的一些原則。接下來的一段時間我將在這里總結我的學習內容,也希望這一系列文章能夠對有需要的人有所幫助。 不考慮任何編碼規(guī)...
摘要:大家好,我是樂字節(jié)的小樂,這次要給大家?guī)淼氖亲兞颗c數(shù)據(jù)類型。本文是第一集編程規(guī)范,關鍵字與標識符。后面我們要寫一個程序的過程。需求分析實現(xiàn)代碼體現(xiàn)注釋的作用解釋說明程序,提高了代碼的閱讀性??梢詭椭覀冋{試程序。 大家好,我是樂字節(jié)的小樂,這次要給大家?guī)淼氖荍ava變量與數(shù)據(jù)類型。本文是第一集:Java編程規(guī)范,關鍵字與標識符。showImg(https://segmentfaul...
摘要:二格式規(guī)范在上一篇的編程規(guī)范一中我們講述了在編碼中的一般原則,雖然這些原則并不涉及具體的代碼規(guī)范,但是這些原則卻是我們在開發(fā)過程中所應該遵循的規(guī)范與思想。不要把多個語句放在同一行里以免超過最大可接受寬度。 二、格式規(guī)范 在上一篇的java編程規(guī)范(一)中我們講述了在Java編碼中的一般原則,雖然這些原則并不涉及具體的代碼規(guī)范,但是這些原則卻是我們在Java開發(fā)過程中所應該遵循的規(guī)范與思...
摘要:在上一篇的編程風格學習二中我們學習了一些在編碼過程中的格式規(guī)范,遵循這些規(guī)范毋庸置疑是我們的書寫高質量代碼的前提與基礎。二語言編程規(guī)范常量命名常量的每個單詞均大寫,單詞之間使用下劃線連接。方法表示動作,采用動詞命名。 在上一篇的java編程風格學習(二)中我們學習了一些在Java編碼過程中的格式規(guī)范,遵循這些規(guī)范毋庸置疑是我們的書寫高質量代碼的前提與基礎。今天我們更進一步,一起來學習J...
摘要:對變量對象或者函數(shù)等進行命名時,選擇能清晰表達其用途的名字。其實,測試方法名應該明確指出測試的內容與條件。和這種命名方式是時代的前朝遺物。使用自己的異常類型筆者又一次錯誤地認為這一開發(fā)習慣是業(yè)內的共識。 作為 Java 開發(fā)人員,我們會遵循一系列的編碼風格和開發(fā)習慣。習慣使然是一方面,另一方面,我們也從不停下腳步質疑這些習慣。一段時間以后,筆者養(yǎng)成了一些不同于常人的編碼風格和開發(fā)習慣。...
閱讀 1893·2021-09-24 09:48
閱讀 3236·2021-08-26 14:14
閱讀 1693·2021-08-20 09:36
閱讀 1481·2019-08-30 15:55
閱讀 3643·2019-08-26 17:15
閱讀 1440·2019-08-26 12:09
閱讀 618·2019-08-26 11:59
閱讀 3338·2019-08-26 11:57