建站
咨詢
售后
建站咨詢
新聞中心
北大青鳥(niǎo)java培訓(xùn)：如何規(guī)范自己的代碼編輯方式？
對(duì)于程序員來(lái)說(shuō)，養(yǎng)成良好的代碼寫(xiě)作能力是非常重要的。
成都創(chuàng)新互聯(lián)是一家專注于做網(wǎng)站、網(wǎng)站設(shè)計(jì)與策劃設(shè)計(jì),獻(xiàn)縣網(wǎng)站建設(shè)哪家好?成都創(chuàng)新互聯(lián)做網(wǎng)站,專注于網(wǎng)站建設(shè)十余年,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:獻(xiàn)縣等地區(qū)。獻(xiàn)縣做網(wǎng)站價(jià)格咨詢:18982081108
今天，我們就一起來(lái)了解一下，規(guī)范化的代碼編寫(xiě)都有哪些要求。
希望通過(guò)對(duì)本文的閱讀，能夠提高大家對(duì)于代碼規(guī)范的認(rèn)識(shí)。
1.保證代碼壓縮后不出錯(cuò)對(duì)于大型的JSP項(xiàng)目，一般會(huì)在產(chǎn)品發(fā)布時(shí)對(duì)項(xiàng)目包含的所有JSP文件進(jìn)行壓縮處理，比如可以利用GoogleClosureCompilerService對(duì)代碼進(jìn)行壓縮，新版jQuery已改用這一工具對(duì)代碼進(jìn)行壓縮，這一般會(huì)去掉開(kāi)發(fā)時(shí)寫(xiě)的注釋，除去所有空格和換行，甚至可以把原來(lái)較長(zhǎng)的變量名替換成短且無(wú)意義的變量名，這樣做的目的是加快文件的下載速度，同時(shí)也減小網(wǎng)站訪問(wèn)帶來(lái)的額外數(shù)據(jù)流量，另外在代碼保護(hù)上也起到了一點(diǎn)點(diǎn)作用，至少壓縮后的代碼即使被還原還是沒(méi)那么容易一下讀懂的。
要想代碼能正確通過(guò)壓縮，一般要求語(yǔ)句都要以分號(hào)正常結(jié)束，大括號(hào)也要嚴(yán)格結(jié)束等，具體還要看壓縮工具的要求。
所以如果一開(kāi)始沒(méi)有按標(biāo)準(zhǔn)來(lái)做，等壓縮出錯(cuò)后再回去找錯(cuò)誤那是浪費(fèi)時(shí)間。
2.保證代碼能通過(guò)特定IDE的自動(dòng)格式化功能一般較為完善的開(kāi)發(fā)工具(比如AptanaStudio)都有代碼"自動(dòng)格式"化功能，這一功能幫助實(shí)現(xiàn)統(tǒng)一換行、縮進(jìn)、空格等代碼編排，你可以設(shè)置自己喜歡的格式標(biāo)準(zhǔn)，比如左大括號(hào){是否另起一行。
達(dá)到這個(gè)要求的目的在于方便你的開(kāi)發(fā)團(tuán)隊(duì)成員拿你代碼的一個(gè)副本用IDE自動(dòng)格式化成他喜歡或熟悉的風(fēng)格進(jìn)行閱讀。
你同事需要閱讀你的代碼，可能是因?yàn)槟銓?xiě)的是通用方法，他在其它模塊開(kāi)發(fā)過(guò)程中也要使用到，閱讀你的代碼能深入了解方法調(diào)用和實(shí)現(xiàn)的細(xì)節(jié)，這是簡(jiǎn)單API文檔不能達(dá)到的效果。
3.使用標(biāo)準(zhǔn)的文檔注釋這一要求算是基本的，這有利于在方法調(diào)用處看到方法的具體傳參提示，也可以利用配套文檔工具生成html或其它格式的開(kāi)發(fā)文檔供其他團(tuán)隊(duì)成員閱讀，你可以嘗試使用jsdoc-toolkit。
如果你自動(dòng)生成的API是出自一個(gè)開(kāi)放平臺(tái)，就像facebook.com應(yīng)用，那么你的文檔是給天下所有開(kāi)發(fā)者看的。
另外編寫(xiě)完整注釋，也更方便團(tuán)隊(duì)成員閱讀你的代碼，通過(guò)你的參數(shù)描述，團(tuán)隊(duì)成員可以很容易知道你編寫(xiě)的方法傳參與實(shí)現(xiàn)細(xì)節(jié)。
當(dāng)然也方便日后代碼維護(hù)，這樣即使再大的項(xiàng)目，過(guò)了很長(zhǎng)時(shí)間后，回去改點(diǎn)東西也就不至于自己都忘記了當(dāng)時(shí)自己寫(xiě)的代碼是怎么一回事了。
4.使用規(guī)范有意義的變量名使用規(guī)范有意義的變量名可以提高代碼的可讀性，作為大項(xiàng)目開(kāi)發(fā)成員，自己寫(xiě)的代碼不僅僅要讓別人容易看懂。
電腦培訓(xùn)認(rèn)為開(kāi)發(fā)大項(xiàng)目，其實(shí)每個(gè)人寫(xiě)的代碼量可能都比較大，規(guī)范命名，日后自己看回自己的代碼也顯的清晰易懂，比如日后系統(tǒng)升級(jí)或新增功能，修改起代碼來(lái)也輕松多了。
如果到頭發(fā)現(xiàn)自己當(dāng)初寫(xiě)的代碼現(xiàn)在看不太懂了，那還真是天大的笑話了。
如何寫(xiě)出優(yōu)雅Java編程
一、不要使用魔法數(shù)字，盡量定義枚舉、常量、宏：
我常常見(jiàn)到表示各種狀態(tài)的數(shù)字，0，1，2....，我真的不知道這表示什么含義，如果
你在不在文檔中說(shuō)明的話，這個(gè)東東過(guò)幾天連你自己都不知道個(gè)一二三了。
二、命名要具有描述力，盡量使用全名而不是自創(chuàng)的縮寫(xiě)，除非地球人都這么用這個(gè)縮寫(xiě)：
我常?？吹揭恍┳詣?chuàng)的縮寫(xiě)，這個(gè)縮寫(xiě)或許只有你自己知道，類名，方法名，參數(shù)名
尤其要有好的描述里，局部變量尚可容忍。我寧可容忍超過(guò)40個(gè)字符的命令，也不愿意
看到只有一兩個(gè)字母的命名，當(dāng)然迭代用的i,j除外。當(dāng)然命名不要太長(zhǎng)，太長(zhǎng)說(shuō)明你的類和
方法要做的事情太多，請(qǐng)你拆分出更多細(xì)粒度功能單一的類和方法。
三、同一類東東命名方式盡可能統(tǒng)一，比如類名使用大寫(xiě)字母開(kāi)頭的單詞，變量使用
下劃線分割開(kāi)來(lái)的小寫(xiě)字母單詞，常量使用下滑線分割的開(kāi)來(lái)的大寫(xiě)字母單詞。不要
交替使用。
四、函數(shù)、類功能盡可能單一，不要試圖寫(xiě)一個(gè)萬(wàn)能/超級(jí)函數(shù)或者類。
一個(gè)類和方法要有單一的職責(zé)，這樣的類和方法只做一件事，并且容易把他做好。
1、不要試圖寫(xiě)一個(gè)強(qiáng)大無(wú)比的方法。
我常?？吹揭恍┰噲D寫(xiě)的多么“精妙”無(wú)比多么“強(qiáng)大”的函數(shù)，事實(shí)上不是什么精妙，而是
代碼的臭味道。精妙強(qiáng)大無(wú)比萬(wàn)能的方法往往你耗費(fèi)大量精力去設(shè)計(jì)算法，試圖覆蓋現(xiàn)在的各
種可能，而無(wú)法面對(duì)將來(lái)新的需求，隨著新的需求，你的這個(gè)精妙的方法需要的修改并且改起來(lái)
極其痛苦。在一次次的痛苦與精妙的演化中，你的方法越來(lái)越復(fù)雜，并且每一次修改你都會(huì)面
臨影響以前功能的風(fēng)險(xiǎn)。這個(gè)方法使用者需要小心的處理你的精妙之處，如果沒(méi)有精妙傳遞好參
數(shù)，那么這個(gè)方法再也不精妙了，而是直接廢掉了。
KISS（keep it simple and stupid）原理就是這個(gè)道理，你要使你的代碼盡可能簡(jiǎn)單，讓人
看到有一目了然的清爽，而不是因?yàn)樵O(shè)計(jì)了一個(gè)精妙無(wú)比的萬(wàn)能方法而沾沾自喜。這里的簡(jiǎn)單不是
簡(jiǎn)潔的代名字。有時(shí)候簡(jiǎn)潔是那種傳說(shuō)的“精妙”的代碼。
2、不要寫(xiě)做多件事情的方法和類，你做一件事情，你就寫(xiě)一個(gè)對(duì)應(yīng)的方法，不要試圖通過(guò)參數(shù)來(lái)判定各種情況，然后做事情，并且做的事情和你方法描述的不一致。當(dāng)你發(fā)現(xiàn)你的方法名字想不出來(lái)好的名字了，或者要加or和and了，那么請(qǐng)你拆分出更多單一的方法。
不要舉一些linux完成多種功能系統(tǒng)調(diào)用，這是被迫的，因?yàn)橄到y(tǒng)調(diào)用的數(shù)量是有限制的，它只有有限的空間來(lái)描述系統(tǒng)調(diào)用號(hào)和系統(tǒng)調(diào)用的映射表，不要在應(yīng)用程序開(kāi)發(fā)中效仿而誤以為優(yōu)雅強(qiáng)大。我最惡心根據(jù)參數(shù)，然后一大堆的if..else 和switch..case判斷。
五、不要修改已有的類和方法而是擴(kuò)展它。
這是程序設(shè)計(jì)的一個(gè)重要原則，開(kāi)閉原則，在面向?qū)ο蟮恼Z(yǔ)言中尤為重要。在面向過(guò)程中主要表現(xiàn)在，不要在一個(gè)函數(shù)要應(yīng)對(duì)和這個(gè)函數(shù)相似的一個(gè)需求了，就在這個(gè)加個(gè)if，來(lái)修改這個(gè)方法，試圖重用和避免重復(fù)。而是要把公用的部分抽出來(lái)成一個(gè)小的功能函數(shù)，然后增加一個(gè)應(yīng)對(duì)新的類似這個(gè)需求的處理方法。在面向?qū)ο笾?，例如使用策略模式、訪問(wèn)者模式、Extend Object模式。
六、不要重復(fù)你自己（DRY）：
程序最怕的是copy,paste，到處是重復(fù)的代碼。copy，paste經(jīng)常被誤以為快速完成需要用的功能的高效方式而被到處使用。你每重復(fù)一次，你就得負(fù)責(zé)保持他們的一致性，你就得在一處增加新的功能時(shí)，你就的把這個(gè)的功能加到其他地方。還在我剛會(huì)寫(xiě)代碼的時(shí)候去了一個(gè)小公司，他們的代碼到處是copy，paste的痕跡，當(dāng)要在現(xiàn)有的功能增加審計(jì)功能是，他們開(kāi)始下命令了，每個(gè)人加幾行代碼來(lái)做審計(jì)，真不知道那么多人寫(xiě)的審計(jì)版本，分散到那么多處，這個(gè)審計(jì)功能是否可信有用。
避免DRY的方法就是抽象，分離變化。不管是面向?qū)ο筮€是面向過(guò)程，分離變化并抽象之是最主要的設(shè)計(jì)原則。設(shè)計(jì)模式中的模板方法，我們常用的回調(diào)都是我們常用的方法。
我發(fā)現(xiàn)越是提供更多回調(diào)處理的語(yǔ)言和框架，就越具有靈活性和易用性。ruby語(yǔ)言之所以有如此的威力，主要是因?yàn)樗峁┝烁嗟幕卣{(diào)處理。它可以在動(dòng)態(tài)的給一個(gè)類增加方法，這樣可以在超類中定義增加方法的方法，然后再子類調(diào)用，子類就具有無(wú)比的能力。它的block提供了強(qiáng)大的回調(diào)機(jī)制，我只要不知道如何處理了我就yield出來(lái)，method missing機(jī)制更是神秘?zé)o比，你可以寫(xiě)出像find_by_name_and_age,2.days.ago這樣像自然語(yǔ)言一樣易讀的代碼。
七、不要跨越邊界，在適合的地方寫(xiě)代碼。
在分層的架構(gòu)中，不要跨越層的邊界。例如web開(kāi)發(fā)的三層架構(gòu):
數(shù)據(jù)訪問(wèn)層（DAO)、業(yè)務(wù)層(Service)、表現(xiàn)層。
不要在業(yè)務(wù)層裸寫(xiě)SQL來(lái)做事情，不要在業(yè)務(wù)層摻和進(jìn)來(lái)表現(xiàn)層的東東，不要在表現(xiàn)層/控制器中寫(xiě)業(yè)務(wù)的東東。既然已經(jīng)分層了，那么就要好好的遵守它，如果到處跨越邊界的話，那么和不分層沒(méi)有什么區(qū)別，使得每一層都不倫不類。例如你應(yīng)該在業(yè)務(wù)層進(jìn)行事務(wù)管理，而你的控制器到處是業(yè)務(wù)代碼，那將無(wú)法控制。如果你的業(yè)務(wù)層到處是SQL，我不知道你的DAO存在的意義了。
八、分層的web架構(gòu)：
DAO層最好按照模型來(lái)劃分dao類，如果業(yè)務(wù)很簡(jiǎn)單，也可以將相關(guān)的模型合并為一個(gè)DAO。
Service層，不要按照DAO和Service一一對(duì)應(yīng)的方式劃分，而是要按照業(yè)務(wù)的類別和實(shí)際情況來(lái)劃分。事實(shí)上Service層通常是用來(lái)處理涉及到多個(gè)模型的業(yè)務(wù)，而涉及到一個(gè)模型的業(yè)務(wù)，常常被放在模型中，這是一種自然而更面向?qū)ο蟮脑O(shè)計(jì)方法。只有數(shù)據(jù)的模型被稱為貧血型模型，這種模型被認(rèn)為是對(duì)面向?qū)ο蟮囊环N背離，而在模型中放置專有的業(yè)務(wù)方法，不僅有利于公用，而且模型更具有描述力。
九、關(guān)于MVC:
MVC是一種松耦合的設(shè)計(jì)方案，最容易誤用的就是控制器（c）?？刂破髦回?fù)責(zé)調(diào)用業(yè)務(wù)方法，準(zhǔn)備好數(shù)據(jù)供View去展現(xiàn)。而不要把業(yè)務(wù)和如何展示的東東放在里面。我常?？吹接腥嗽诳刂破髦衅磆tml片段和寫(xiě)一些業(yè)務(wù)相關(guān)的代碼。
十、順便說(shuō)一下異常的使用。
如果你是使用語(yǔ)言支持異常機(jī)制，那么盡可能的使用異常機(jī)制和定義好與自己業(yè)務(wù)相關(guān)的異常，而不是通過(guò)返回值表示正確和錯(cuò)誤。如果你使用的語(yǔ)言支持異常機(jī)制，請(qǐng)不要寫(xiě)類linux下c似的代碼形式，每寫(xiě)一個(gè)函數(shù)，我就寫(xiě)一個(gè)判斷返回值調(diào)用是否成功，嚴(yán)重分離了我對(duì)核心業(yè)務(wù)的關(guān)注。異常提供了優(yōu)雅的處理錯(cuò)誤的方法。
java軟件開(kāi)發(fā)的代碼規(guī)范
1、組織與風(fēng)格
(1).關(guān)鍵詞和操作符之間加適當(dāng)?shù)目崭瘛?/p>
(2).相對(duì)獨(dú)立的程序塊與塊之間加空行
(3).較長(zhǎng)的語(yǔ)句、表達(dá)式等要分成多行書(shū)寫(xiě)。
(4).劃分出的新行要進(jìn)行適應(yīng)的縮進(jìn)，使排版整齊，語(yǔ)句可讀。
(5).長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。
(6).循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分。
(7).若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐帧?/p>
(8).不允許把多個(gè)短語(yǔ)句寫(xiě)在一行中，即一行只寫(xiě)一條語(yǔ)句。
(9).函數(shù)或過(guò)程的開(kāi)始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格。
注：如果大家有興趣可以到安安DIY創(chuàng)作室博客，有相關(guān)說(shuō)明性的文章和解釋。
2、注解
Java 的語(yǔ)法與 C++ 及為相似，那么，你知道 Java 的注釋有幾種嗎？是兩種？
// 注釋一行
/* ...... */ 注釋若干行
不完全對(duì)，除了以上兩種之外，還有第三種，文檔注釋：
/** ...... */ 注釋若干行，并寫(xiě)入 javadoc 文檔
注釋要簡(jiǎn)單明了。
String userName = null; //用戶名
邊寫(xiě)代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。
在必要的地方注釋，注釋量要適中。注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。
保持注釋與其描述的代碼相鄰，即注釋的就近原則。
對(duì)代碼的注釋?xiě)?yīng)放在其上方相鄰位置，不可放在下面。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋?xiě)?yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋?xiě)?yīng)放在此域的右方；
同一結(jié)構(gòu)中不同域的注釋要對(duì)齊。
變量、常量的注釋?xiě)?yīng)放在其上方相鄰位置或右方。
全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。
在每個(gè)源文件的頭部要有必要的注釋信息，包括：文件名；版本號(hào)；作者；生成日期；模塊功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過(guò)程清單及本文件歷史修改記錄等。
/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version : 1.01
* Modification history :2003.5.1
* Sr Date Modified By Why What is modified
* 1. 2003.5.2 Kevin Gao new
**/
在每個(gè)函數(shù)或過(guò)程的前面要有必要的注釋信息，包括：函數(shù)或過(guò)程名稱；功能描述；輸入、輸出及返回值說(shuō)明；調(diào)用關(guān)系及被調(diào)用關(guān)系說(shuō)明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart,
OrderBean orderBean)
throws Exception{
}
javadoc注釋標(biāo)簽語(yǔ)法
@author 對(duì)類的說(shuō)明 標(biāo)明開(kāi)發(fā)該類模塊的作者
@version 對(duì)類的說(shuō)明 標(biāo)明該類模塊的版本
@see 對(duì)類、屬性、方法的說(shuō)明 參考轉(zhuǎn)向，也就是相關(guān)主題
@param 對(duì)方法的說(shuō)明 對(duì)方法中某參數(shù)的說(shuō)明
@return 對(duì)方法的說(shuō)明 對(duì)方法返回值的說(shuō)明
@exception 對(duì)方法的說(shuō)明 對(duì)方法可能拋出的異常進(jìn)行說(shuō)明
3、命名規(guī)范
定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫(xiě)的，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。（這些規(guī)范并不是一定要絕對(duì)遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過(guò)去掉元音形成縮寫(xiě)；要不然最后自己寫(xiě)的代碼自己都看不懂了，那可不行。
較長(zhǎng)的單詞可取單詞的頭幾發(fā)符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。
使用匈牙利表示法
Package 的命名
Package 的名字應(yīng)該都是由一個(gè)小寫(xiě)單詞組成。
package com.neu.util
Class 的命名
Class 的名字必須由大寫(xiě)字母開(kāi)頭而其他字母都小寫(xiě)的單詞組成,對(duì)于所有標(biāo)識(shí)符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫(xiě)中間單詞的首字母。
public class ThisAClassName{}
Class 變量的命名
變量的名字必須用一個(gè)小寫(xiě)字母開(kāi)頭。后面的單詞用大寫(xiě)字母開(kāi)頭
userName , thisAClassMethod
Static Final 變量的命名
static Final 變量的名字應(yīng)該都大寫(xiě)，并且指出完整含義。
/**
*DBConfig PATH
**/
public static final String
DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;
參數(shù)的命名
參數(shù)的名字必須和變量的命名規(guī)范一致。
數(shù)組的命名
數(shù)組應(yīng)該總是用下面的方式來(lái)命名：
byte[] buffer;
而不是：
byte buffer[];
方法的參數(shù)
使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名字：
SetCounter(int size){
this.size = size;
}
4、文件樣式
所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則：
版權(quán)信息
版權(quán)信息必須在 java 文件的開(kāi)頭，比如：
/*
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/
其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。
Package/Imports
package 行要在 import 行之前，import 中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母
順序排列。如果 import 行中包含了同一個(gè)包中的不同子目錄，則應(yīng)該用 * 來(lái)處理。
package hotlava.net.stats;
import java io.*;
import java.util.Observable;
import hotlava.util.Application;
這里 java。io.* 使用來(lái)代替InputStream and OutputStream 的。
Class
接下來(lái)的是類的注釋，一般是用來(lái)解釋類的。
/**
* A class representing a set of packet and byte counters
* It is observable to allow it to be watched, but only
* reports changes when the current set is complete
*/
接下來(lái)是類定義，包含了在不同的行的 extends 和 implements
public class CounterSet
extends Observable
implements Cloneable
Class Fields
接下來(lái)是類的成員變量：
/**
* Packet counters
*/
protected int[] packets;
public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義的成
員變量如果名字含義明確的話，可以沒(méi)有注釋。
存取方法
接下來(lái)是類變量的存取的方法。它只是簡(jiǎn)單的用來(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); }
public 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)類型 (public, private 等.) 和 任何 static, final 或 synchronized 應(yīng)該在一行
中，并且方法和參數(shù)另寫(xiě)一行，這樣可以使方法和參數(shù)更易讀。
public
CounterSet(int size){
this.size = size;
}
克隆方法
如果這個(gè)類是可以被克隆的，那么下一步就是 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());
}
}
類方法
下面開(kāi)始寫(xiě)類的方法：
/**
* Set the packet counters
* (such as when restoring from a database)
*/
protected final
void 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 new 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è)類都應(yīng)該定義 toString 方法：
public
String toString() {
String retval = CounterSet: ;
for (int i = 0; i data.length(); i++) {
retval += data.bytes.toString();
retval += data.packets.toString();
}
return retval;
}
}
main 方法
如果main(String[]) 方法已經(jīng)定義了, 那么它應(yīng)該寫(xiě)在類的底部.
5、代碼可讀性
避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來(lái)替代。
不要使用難懂的技巧性很高的語(yǔ)句。
源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。
6、代碼性能
在寫(xiě)代碼的時(shí)候，從頭至尾都應(yīng)該考慮性能問(wèn)題。這不是說(shuō)時(shí)間都應(yīng)該浪費(fèi)在優(yōu)化代碼上，而是我們時(shí)刻應(yīng)該提醒自己要注意代碼的效率。比如：如果沒(méi)有時(shí)間來(lái)實(shí)現(xiàn)一個(gè)高效的算法，那么我們應(yīng)該在文檔中記錄下來(lái)，以便在以后有空的時(shí)候再來(lái)實(shí)現(xiàn)她。
不是所有的人都同意在寫(xiě)代碼的時(shí)候應(yīng)該優(yōu)化性能這個(gè)觀點(diǎn)的，他們認(rèn)為性能優(yōu)化的問(wèn)題應(yīng)該在項(xiàng)目的后期再去考慮，也就是在程序的輪廓已經(jīng)實(shí)現(xiàn)了以后。
不必要的對(duì)象構(gòu)造
不要在循環(huán)中構(gòu)造和釋放對(duì)象
使用 StringBuffer 對(duì)象
在處理 String 的時(shí)候要盡量使用 StringBuffer 類，StringBuffer 類是構(gòu)成 String 類的基礎(chǔ)。
String 類將 StringBuffer 類封裝了起來(lái)，（以花費(fèi)更多時(shí)間為代價(jià)）為開(kāi)發(fā)人員提供了一個(gè)安全的接口。當(dāng)我們?cè)跇?gòu)造字符串的時(shí)候，我們應(yīng)該用 StringBuffer 來(lái)實(shí)現(xiàn)大部分的工作，當(dāng)工作完成后將 StringBuffer 對(duì)象再轉(zhuǎn)換為需要的 String 對(duì)象。比如：如果有一個(gè)字符串必須不斷地在其后添加許多字符來(lái)完成構(gòu)造，那么我們應(yīng)該使用StringBuffer 對(duì)象和她的 append() 方法。如果我們用 String 對(duì)象代替StringBuffer 對(duì)象的話，會(huì)花費(fèi)許多不必要的創(chuàng)建和釋放對(duì)象的 CPU 時(shí)間。大家可以來(lái)安安DIY創(chuàng)作室一起討論。
避免太多的使用 synchronized 關(guān)鍵字避免不必要的使用關(guān)鍵字 synchronized，應(yīng)該在必要的時(shí)候再使用她，這是一個(gè)避免死鎖的好方法。
7、編程技巧
byte 數(shù)組轉(zhuǎn)換到 characters
為了將 byte 數(shù)組轉(zhuǎn)換到 characters，你可以這么做：
Hello world!.getBytes();
Utility 類
Utility 類（僅僅提供方法的類）應(yīng)該被申明為抽象的來(lái)防止被繼承或被初始化。
初始化
下面的代碼是一種很好的初始化數(shù)組的方法：
objectArguments = new Object[] { arguments };
枚舉類型
JAVA 對(duì)枚舉的支持不好，但是下面的代碼是一種很有用的模板：
class Colour {
public static final Colour BLACK = new 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, BLUE 等可以象其他語(yǔ)言的枚舉類型一樣使用的常量。
他們可以用 '==' 操作符來(lái)比較。
但是這樣使用有一個(gè)缺陷：如果一個(gè)用戶用這樣的方法來(lái)創(chuàng)建顏色 BLACK new Colour(0,0,0)
那么這就是另外一個(gè)對(duì)象，'=='操作符就會(huì)產(chǎn)生錯(cuò)誤。她的 equal() 方法仍然有效。由于這個(gè)原因，這個(gè)技術(shù)的缺陷最好注明在文檔中，或者只在自己的包中使用。
8、編寫(xiě)格式
代碼樣式
代碼應(yīng)該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）
文檔化
必須用 javadoc 來(lái)為類生成文檔。不僅因?yàn)樗菢?biāo)準(zhǔn)，這也是被各種 java 編譯器都認(rèn)可的方法。使用 @author 標(biāo)記是不被推薦的，因?yàn)榇a不應(yīng)該是被個(gè)人擁有的。
縮進(jìn)
縮進(jìn)應(yīng)該是每行2個(gè)空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時(shí)Tab字符將因?yàn)橛脩粼O(shè)置的不同而擴(kuò)展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過(guò)如下操作來(lái)禁止保存Tab字符, 方法是通過(guò) UltrEdit中先設(shè)定 Tab 使用的長(zhǎng)度室2個(gè)空格，然后用 Format|Tabs to Spaces 菜單將 Tab 轉(zhuǎn)換為空格。
頁(yè)寬
頁(yè)寬應(yīng)該設(shè)置為80字符. 源代碼一般不會(huì)超過(guò)這個(gè)寬度, 并導(dǎo)致無(wú)法完整顯示, 但這一設(shè)置也可以靈活調(diào)整. 在任何情況下, 超長(zhǎng)的語(yǔ)句應(yīng)該在一個(gè)逗號(hào)或者一個(gè)操作符后折行. 一條語(yǔ)句折行后, 應(yīng)該比原來(lái)的語(yǔ)句再縮進(jìn)2個(gè)字符.
{} 對(duì)
{} 中的語(yǔ)句應(yīng)該單獨(dú)作為一行. 例如, 下面的第1行是錯(cuò)誤的, 第2行是正確的:
if (i0) { i ++ }; // 錯(cuò)誤, { 和 } 在同一行
if (i0) {
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è)字符之間也不應(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)
9、代碼編譯
1.編寫(xiě)代碼時(shí)要注意隨時(shí)保存，并定期備份，防止由于斷電、硬盤(pán)損壞等原因造成代碼丟失。
2.同一項(xiàng)目組內(nèi)，最好使用相同的編輯器，并使用相同的設(shè)置選項(xiàng)。
3.合理地設(shè)計(jì)軟件系統(tǒng)目錄，方便開(kāi)發(fā)人員使用。
4.打開(kāi)編譯器的所有告警開(kāi)關(guān)對(duì)程序進(jìn)行編譯。
5.在同一項(xiàng)目組或產(chǎn)品組中，要統(tǒng)一編譯開(kāi)關(guān)選項(xiàng)。
6.使用工具軟件（如Visual SourceSafe）對(duì)代碼版本進(jìn)行維護(hù)。如果大家有不明白的可以到安安DIY創(chuàng)作室留言。
10、可移植性
Borland Jbulider 不喜歡 synchronized 這個(gè)關(guān)鍵字，如果你的斷點(diǎn)設(shè)在這些關(guān)鍵字的作用域內(nèi)的話，調(diào)試的時(shí)候你會(huì)發(fā)現(xiàn)的斷點(diǎn)會(huì)到處亂跳，讓你不知所措。除非必須，盡量不要使用。
換行
如果需要換行的話，盡量用 println 來(lái)代替在字符串中使用\n。
你不要這樣：
System.out.print(Hello,world!\n);
要這樣：
System.out.println(Hello,world!);
或者你構(gòu)造一個(gè)帶換行符的字符串，至少要象這樣：
String newline = System.getProperty(line.separator);
System.out.println(Hello world + newline);
PrintStream
PrintStream 已經(jīng)被不贊成（deprecated）使用，用 PrintWrite 來(lái)代替它。
當(dāng)前題目：java代碼優(yōu)雅規(guī)范 javagui代碼
網(wǎng)站鏈接：http://www.dlmjj.cn/article/dosjipp.html
