一、規(guī)范存在的意義 2
二、命名規(guī)范 3
1、一般概念 3
2、標識符類型說明 3
1、包( Package )的命名 4
2、類( Class )的命名 4
3、接口( Interface )的命名 4
4、枚舉( Enum )的命名 4
5、異常( Exception )的命名 4
6、方法( Method )的命名 4
7、參數( Param )的命名 5
8、變量和常量的命名 5
9 、Javadoc注釋 5
三、注釋規(guī)范 6
一、背景 6
二、意義 6
三、注釋的原則 6
四、JAVA注釋技巧 8
四、代碼格式規(guī)范 9
一、代碼格式 9
1.1格式的目的 10
2.2 垂直格式 10
2.3橫向格式 11
五、工程命名規(guī)范 12
1.1程序名 12
2.1、持久層 13
2. 2、服務層 13
2. 3、MVC 層 14
2. 4、Spring 配置文件 14
2. 5、JSP 文件 14
3.代碼工程(PG工程) 14
3.1 .Java文件包的結構(目錄結構) 15
3.2.Import 的命名規(guī)則 15
3.3.對象名稱 15
3.4.變量的命名規(guī)則 15
3.5.方法的命名規(guī)則 16
3.6 .JSP畫面的目錄結構。 16
3.7.不好的無意義的命名。 16
六、其他 17
1、數組的命名 17
2、括號 17
3、final 類 17
4、訪問類的成員變量 17
5、使用 StringBuffer 對象 17
6、避免太多的使用 synchronized 關鍵字 18
7、換行 18
8、PrintStream 18
9、代碼簡潔高效 18
10、JSP頁面客戶體驗 19
11、代碼操作規(guī)范 19
七、J2EE規(guī)范 20
1.1.1 J2EE規(guī)范 20
1.1.2 J2EE組件層次 20
1.客戶端層(Client Tier) 21
2.Web層 21
3.業(yè)務層(Business Tier) 21
4.企業(yè)信息系統(tǒng)層(Enterprise Information System tier) 21
5.J2EE的分布應用技術 21
八、JAVA編程規(guī)范 22
1. 應用范圍 23
2. 設計類和方法 23
一、規(guī)范存在的意義
JAVA程序員能夠依據JAVA編程規(guī)范養(yǎng)成良好的編程習慣,是編寫良好JAVA程序的先決條件。對于JAVA編程規(guī)范首先要準確理解。例如,每行聲明一個局部變量,不僅僅要知道是JAVA編程規(guī)范的要求,更重要的是要理解這樣增加了代碼的易懂性。理解好JAVA編程規(guī)范是發(fā)揮規(guī)范作用的基礎。理解規(guī)范中每個個原則僅僅是開始,進一步需要相信這些規(guī)范是編碼的最好方法,并且在編程過程中堅持應用!×硗,應該在編程過程中堅持一貫遵循這些規(guī)范,培養(yǎng)成習慣,這樣能夠保證開發(fā)出干凈代碼(Clean code),使開發(fā)和維護工作更簡單。從一開始就寫干凈的代碼,可以在程序開發(fā)過程中以及程序維護階段不斷受益。
應用編碼規(guī)范對于軟件本身和軟件開發(fā)人員而言尤為重要,有以下幾個原因:
1、好的編碼規(guī)范可以盡可能的減少一個軟件的維護成本 , 并且?guī)缀鯖]有任何一個軟件,在其整個生命周期中,均由最初的開發(fā)人員來維護;
2、好的編碼規(guī)范可以改善軟件的可讀性,可以讓開發(fā)人員盡快而徹底地理解新的代碼;
3、好的編碼規(guī)范可以最大限度的提高團隊開發(fā)的合作效率;
|
|