軟件開發(fā)代碼規(guī)范(Java)

1、軟件開發(fā)代碼規(guī)范（C）（僅通普信息技術(shù)股份有限公司供內(nèi)部使用）擬制：楊超日期：2015-3-10審核：夏峰日期：2015-3-10核準(zhǔn)：馮敬剛?cè)掌冢?015-3-17簽發(fā)：韓殿成日期：2015-3-21文檔版本：VI. 11黑龍江通普信息技術(shù)股份有限公司版本歷史日期版本說明作者目錄第一章代碼開發(fā)規(guī)范及其指南11.1 目的11.2 程序內(nèi)命名規(guī)范1L3文件命名規(guī)范2L4JAVA文件樣式2L5代碼編寫格式6第二章程序編寫規(guī)范方法82.1 權(quán)限修飾82.2 其他規(guī)范82.3 編程指南10第三章其他要求12第一章代碼開發(fā)規(guī)范及其指南1.1 目的定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的

2、，增 加可讀性，減少項目組中因為換人而帶來的損失。（這些規(guī)范并不是一定要絕 對遵守，但是一定要讓程序有良好的可讀性）1.2 程序內(nèi)命名規(guī)范 Package的命名：Package的名字應(yīng)該都是由一個小寫單詞組成。 Class的命名：Class的名字必須由大寫字母開頭而其他字母都小寫的單詞 組成 Class變量的命名：變量的名字必須用一個小寫字母開頭。后面的單詞用大 寫字母開頭。 Static Final變量的命名：Static Final變量的名字應(yīng)該都大寫，并且指出完 整含義。 參數(shù)的命名：參數(shù)的名字必須和變量的命名規(guī)范一致。 數(shù)組的命名：數(shù)組應(yīng)該總是用下面的方式來命名：byte buffer

3、;而不是 byte bufferf; 方法的參數(shù)：使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字 段一樣的名字：SetCounter(int size) this.size = size;1.3 文件命名規(guī)范 文件名由英文單詞組成，每個單詞的首字母大寫，不要超過4個單詞, 如 ShipOrder.jspo Java文件的文件名要與程序中的public類名相同。 Servet 文件要以 Servlet 做為結(jié)尾，如 AddCompanyServlet.java 業(yè)務(wù)處理組件JavaBean要以Bean為結(jié)尾，如ProcessBean.java1.4 Java文件樣式所有的Java( * .

4、j ava)文件都必須遵守如下的樣式規(guī)則頭部版權(quán)信息版權(quán)信息必須在java文件的開頭，比如：* Copyright 2002 Sun Microsystems, Inc. All rights reserved.*/其他不需要出現(xiàn)在javadoc的信息也可以包含在這里。 Package/Importspackage行要在import行之前，import中標(biāo)準(zhǔn)的包名要在本地的包名之 前，而且按照字母順序排列。如果import行中包含了同一個包中的不同子目 錄，則應(yīng)該用*來處理。package .stats;import java.io.*;import java.util.Observable;

5、import hotlava.util.Application;這里 java.io. Get the counters 使用來代替 InputStream and OutputStream 的。 Class接下來的是類的注釋，一般是用來解釋類的相關(guān)信息，包括標(biāo)題、描述、。* <p>Title: Example</p>* <p>Description: AuditApplicationExample</p>* <p>Copyright: Copyright (c) 200x</p>* <p>Company: x

6、xxxx</p>* ©author xxxxxx* ©version 1.0* /接下來是類定義，包含了在不同的行的extends和implements public class CounterSet extends Observable implements Cloneable Class Fields接下來是類的成員變量:* Packet counters*/protected int packets;public 的成員變量必須生成文檔（JavaDoc） o protected> private 和 package 定義的成員變量如果名字含義明確的話

7、，可以沒有注釋。存取方法接下來是類變量的存取的方法。它只是簡單的用來將類的變量賦值獲取值 的話，可以簡單的寫在一行上。* ©return an array containing the statistical data. This array has been* freshly allocated and can be modified by the caller.*/public int getPackets() return copyArray(packets, offset); public int getBytes() return copyArray(bytes, offs

8、et); public int getPackets() return packets; public void setPackets(int packets) this.packets = packets; 其它的方法不要寫在一行上構(gòu)造函數(shù)接下來是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫(比如：參數(shù)多的寫在后 面)。訪問類型("public", "private"等.)和任何"static", "final"或"synchronized" 應(yīng)該在一行中。Public CounterSet (int si

9、ze) this.size = size;1克隆方法如果這個類是可以被克隆的，那么下一步就是clone方法：public Object clone() try CounterSet obj = (CounterSet)super.clone();obj.packets = (int)packets.clone();obj.size = size;return obj;catch(CloneNotSupportedException e) throw new InternalEiTor(HUnexpected CloneNotSUpportedException: " + e.getM

10、essage();)1類方法下面開始寫類的方法：/* Set the packet counters* (such as when restoring from a database)* /protected finalvoid setArray(int rl, int r2, int r3, int r4)throws IllegalArgumentException(/ Ensure the arrays are of equal size/if (rl.length != r2.length II rl.length != r3.length II rl.length != r4.1en

11、gth) throw new IllegalArgumentException(HArrays must be of the same size");System.arraycopy(r 1, 0, r3, 0, rl.length);S y stem. array cop y( r2, 0, r4, 0, rl.length);1 toString 方法無論如何，每一個類都應(yīng)該定義toString方法: publicString toString() String retval = "CounterSet: for (int i = 0; i < data.leng

12、th(); i+) retval += data.bytes.toStringO； retval += data.packets.toStringO； ) return retval;1 main方法如果main(String)方法已經(jīng)定義了，那么它應(yīng)該寫在類的底部.1.5代碼編寫格式 代碼樣式代碼應(yīng)該用unix的格式，而不是windows的(比如：回車變成回車+換行) 文檔化必須用javadoc來為類生成文檔。不僅因為它是標(biāo)準(zhǔn)，這也是被各種java 編譯器都認(rèn)可的方法。 縮進(jìn)縮進(jìn)應(yīng)該是每行4個空格.不要在源文件中保存Tab字符.在使用不同的源 代碼管理工具時Tab字符將因為用戶設(shè)置的不同而擴(kuò)

13、展為不同的寬度.如果你使用UltraEdit作為Java源代碼編輯器的話，你可以通過如下操作來禁止 保存Tab字符，方法是通過UltrEdit中先設(shè)定Tab使用的長度是4個空格，然后 用FormatITabs to Spaces菜單將Tab轉(zhuǎn)換為空格。 頁寬頁寬應(yīng)該設(shè)置為80字符.源代碼一般不會超過這個寬度，并導(dǎo)致無法完整顯 示，但這一設(shè)置也可以靈活調(diào)整.在任何情況下，超長的語句應(yīng)該在一個逗號或者 一個操作符后折行.一條語句折行后,應(yīng)該比原來的語句再縮進(jìn)2個字符. 程序塊要有大括號，即使只有一句程序)中的語句應(yīng)該單獨(dú)作為一行.例如，下面的第1行是錯誤的，第2行是正確的：if(i>0) i

14、+ ; 錯誤，和在同一行if (i>0) i +； 正確，單獨(dú)作為一行語句永遠(yuǎn)單獨(dú)作為一行.如果語句應(yīng)該縮進(jìn)到與其相對應(yīng)的那一行相對齊的位置。 括號左括號和后一個字符之間不應(yīng)該出現(xiàn)空格，同樣，右括號和前一個字符之間 也不應(yīng)該出現(xiàn)空格.下面的例子說明括號和空格的錯誤及正確使用：CallProc( AParameter ); 錯誤CallProc(AParameter); / 正確不要在語句中使用無意義的括號.括號只應(yīng)該為達(dá)到某種目的而出現(xiàn)在源代碼 中。下面的例子說明錯誤和正確的用法：if (I) = 42) /錯誤-括號毫無意義if(I = 42) or (J = 42) then 正確-

15、的確需要括號 import對于import語句，如果某一個包中引用的類不超過三個(包括三個)，不 允許用import xxx.*;格式。 變量定義及方法的返回值不允許使用全包名，如java.kmg.String,除非在不同 的包中有相同名字的類，必須用全名來區(qū)分。對于類中屬性的存取要用方法 (getXXX/setXXX, boolean 值用 isXXX/setXXX)，不要直接引用。第二章程序編寫規(guī)范方法2.1權(quán)限修飾Java中權(quán)限修飾符有三個：public,private,protected,另外一種是不寫這三種的 任何一個，稱為(default).1)對于外部類，只能用public或(d

16、efault),而且一個文件中最多只能有一個 public類。但是內(nèi)部類這四種都可以使用。2)如果對某些數(shù)據(jù)或方法只允許其所在類使用，用private修飾。3)如果對某些數(shù)據(jù)或方法允許本類或同包類使用，用(default)，即不寫任 何修飾符。4)如果對某些數(shù)據(jù)或方法允許本類，同包類，或非同包子類使用，用protected.如果對某些數(shù)據(jù)或方法允許任何類使用，用public修飾。2.2其他規(guī)范 exit()exit除了在main中可以被調(diào)用外，其他的地方不應(yīng)該調(diào)用。因為這樣做不 給任何代碼代碼機(jī)會來截獲退出。一個類似后臺服務(wù)的程序不應(yīng)該因為某一個 庫模塊決定了要退出就退出。異常關(guān)鍵操作如涉及到

17、數(shù)據(jù)庫操作和多個關(guān)鍵處理步驟時應(yīng)當(dāng)采用try,catch語 句，以便于捕獲異常(各類Exception)和異常處理。垃圾收集JAVA使用成熟的后臺垃圾收集技術(shù)來代替引用計數(shù)。但是這樣會導(dǎo)致一個問題：必須在使用完對象的實例以后進(jìn)行清場工作。除非輸出流一出作用域就關(guān)閉，非引用計數(shù)的程序語言，比如JAVA,是不 能自動完成變量的清場工作的。必須象下面一樣寫：FileOutputStream fos = new FileOutputStream(projectFile);project.save(fos, nIDE Project File")；fos.close(); Clone下面是一種

18、有用的方法：implements CloneablepublicObject clone() ( try ThisClass obj = (ThisClass)super.clone();obj.field 1 = (int)fieldl.clone();obj.field2 = field2; return obj; catch(CloneNotSupportedException e) throw new InternalError(HUnexpected CloneNotSUpportedException: " + e.getMessage();) ) final 類絕對不要

19、因為性能的原因?qū)㈩惗x為final的(除非程序的框架要求) 如果一個類還沒有準(zhǔn)備好被繼承，最好在類文檔中注明，而不要將她定義為 final的。這是因為沒有人可以保證會不會由于什么原因需要繼承她。訪問類的成員變量大部分的類成員變量應(yīng)該定義為protected的來防止繼承類使用他們。注意,要用packets*,而不是“int packets”，后一種永遠(yuǎn)也不要用。 public void setPackets(int packets) this.packets = packets; CounterSet(int size)(this.size = size;)2.3編程指南1 > byte

20、數(shù)組轉(zhuǎn)換到 characters為了將byte數(shù)組轉(zhuǎn)換到characters,可以這么做："Hello world!H.getBytes();2、Utility 類Utility類(僅僅提供方法的類)應(yīng)該被申明為抽象的來防止被繼承或被初 始化。3、初始化下面的代碼是一種很好的初始化數(shù)組的方法：objectArguments = new Objectf arguments ;4、枚舉類型JAVA對枚舉的支持不好，但是下面的代碼是一種很有用的模板：class Colour public static final Colour BLACK = new Colour。0, 0);public

21、 static final Colour RED = new Colour(0xFF, 0, 0);public static final Colour GREEN = new Colour(0, OxFF, 0);public static final Colour BLUE = new Colour(0, 0, OxFF);public static final Colour WHITE = new Colour(0xFF5 OxFF, OxFF);1這種技術(shù)實現(xiàn)了 RED, GREEN, BLUE等可以象其他語言的枚舉類型一樣使 用的常量。他們可以用'='操作符來比較。但是這樣使用有一個缺陷：如果一個用戶用這樣的方法來創(chuàng)建顏色BLACKnew Colour(0,050)那么這就是另外一個對象，三二'操作符就會產(chǎn)生錯誤。她的equal()方法仍 然有效。由于這個原因，這個技術(shù)的缺陷最好注明在文檔中，或者只在自己的 包中使用。性能1、在寫代碼的時候，從頭至尾都應(yīng)該考慮性能問題，要注意代碼的效率。2、不必要的對象構(gòu)造3、不要在循環(huán)中構(gòu)造和釋放對象4、使用 StringBuffer 對象在處理S