軟件的開(kāi)發(fā)代碼要求規(guī)范Java

1、實(shí)用標(biāo)準(zhǔn)文案軟件開(kāi)發(fā)代碼規(guī)范（C）（僅通普信息技術(shù)股份有限公司供內(nèi)部使用）擬制：楊超日期：2015-3-10審核：夏峰日期：2015-3-10核準(zhǔn)：馮敬剛?cè)掌冢?015-3-17簽發(fā)：韓殿成日期：2015-3-21文檔版本：V1.11黑龍江通普信息技術(shù)股份有限公司版本歷史日期版本說(shuō)明作者目錄第一章代碼開(kāi)發(fā)規(guī)范及其指南 11.1 目的 11.2 程序內(nèi)命名規(guī)范 11.3 文件命名規(guī)范 21.4 JAVA文件樣式 21.5 代碼編寫(xiě)格式 6第二章程序編寫(xiě)規(guī)范方法 92.1 權(quán)限修飾 92.2 其他規(guī)范 92.3 編程指南 11第三章其他要求13精彩文檔第一章代碼開(kāi)發(fā)規(guī)范及其指南1.1 目的定義這個(gè)

2、規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫(xiě)的，增 加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。(這些規(guī)范并不是一定要絕 對(duì)遵守，但是一定要讓程序有良好的可讀性)1.2 程序內(nèi)命名規(guī)范Package的命名：Package的名字應(yīng)該都是由一個(gè)小寫(xiě)單詞組成。Class的命名：Class的名字必須由大寫(xiě)字母開(kāi)頭而其他字母都小寫(xiě)的單 詞組成Class變量的命名：變量的名字必須用一個(gè)小寫(xiě)字母開(kāi)頭。后面的單詞用 大寫(xiě)字母開(kāi)頭。Static Final 變量的命名：Static Final變量的名字應(yīng)該都大寫(xiě)，并且指出完整含義。參數(shù)的命名：參數(shù)的名字必須和變量的命名規(guī)范一致。數(shù)組的命名：數(shù)組應(yīng)該總是用下

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

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

5、util.Observable;import hotlava.util.Application;這里 java.io.* 使用來(lái)代替 InputStream and OutputStream 的。Class接下來(lái)的是類(lèi)的注釋?zhuān)话闶怯脕?lái)解釋類(lèi)的相關(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*/接下來(lái)是類(lèi)定義，包含了在不同的行的extends 和implementspublic class CounterSet extends Observable implements CloneableClass Fields接下來(lái)是類(lèi)的成員變量:/* Packet counters*/protected int口 packets;public 的成員變量必須生成文檔（JavaDoc） 。 protected、private 和package定義的成員變量如果名字含義明確的話，可以沒(méi)有注釋。存取方法接下來(lái)是類(lèi)變

7、量的存取的方法。它只是簡(jiǎn)單的用來(lái)將類(lèi)的變量賦值獲取值的話，可以簡(jiǎn)單的寫(xiě)在一行上* Get the counters* 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, offset); pub

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

9、his.size = size;克隆方法如果這個(gè)類(lèi)是可以被克隆的，那么下一步就是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 InternalError("Unexpected CloneNotSUpportedException:+ e.getMessage();

10、類(lèi)方法卜面開(kāi)始寫(xiě)類(lèi)的方法:/* * Set the packet counters * (such as when restoring from a database) */ protected finalvoid setArray(int r1, int r2, int r3, int r4)throws IllegalArgumentException/ Ensure the arrays are of equal size/if (r1.length != r2.length | r1.length != r3.length |r1.length != r4.length)throw n

11、ew IllegalArgumentException("Arrays must be of the same size");System.arraycopy(r1,0, r3, 0, r1.length);System.arraycopy(r2, 0, r4, 0, r1.length);toString 方法無(wú)論如何，每一個(gè)類(lèi)都應(yīng)該定義toString 方法:publicString toString() String retval = "CounterSet:"for (int i = 0; i < data.length(); i+) re

12、tval += data.bytes.toString();retval += data.packets.toString();return retval;main方法如果main(String)方法已經(jīng)定義了，那么它應(yīng)該寫(xiě)在類(lèi)的底部.1.5代碼編寫(xiě)格式代碼樣式代碼應(yīng)該用unix 的格式，而不是windows的(比如：回車(chē)變成回車(chē)+換行) 文檔化必須用javadoc 來(lái)為類(lèi)生成文檔。不僅因?yàn)樗菢?biāo)準(zhǔn)，這也是被各種 java編譯器都認(rèn)可的方法?？s進(jìn)縮進(jìn)應(yīng)該是每行4個(gè)空格.不要在源文件中保存Tab字符.在使用不同的 源代碼管理工具時(shí)Tab字符將因?yàn)橛脩?hù)設(shè)置的不同而擴(kuò)展為不同的寬度.如果你使用Ult

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

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

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

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

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

18、卜面是一種有用的方法：implements CloneablepublicObject clone()try ThisClass obj = (ThisClass)super.clone();obj.field1 = (int)field1.clone();obj.field2 = field2;return obj; catch(CloneNotSupportedException e) throw new InternalError("Unexpected CloneNotSUpportedException:+ e.getMessage();final 類(lèi)絕對(duì)不要因?yàn)樾阅艿脑?/p>

19、將類(lèi)定義為final 的(除非程序的框架要求)如果一個(gè)類(lèi)還沒(méi)有準(zhǔn)備好被繼承，最好在類(lèi)文檔中注明，而不要將她定義為 final的。這是因?yàn)闆](méi)有人可以保證會(huì)不會(huì)由于什么原因需要繼承她。訪問(wèn)類(lèi)的成員變量大部分的類(lèi)成員變量應(yīng)該定義為protected的來(lái)防止繼承類(lèi)使用他們。注意，要用"int packets" ,而不是"int packets" ,后一種永遠(yuǎn)也不要 用。public void setPackets(int口 packets) this.packets = packets; CounterSet(int size)this.size = size;

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

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