java規(guī)范代碼格式 Java編碼格式

java編碼規(guī)范有哪些？

JAVA代碼規(guī)范：

創(chuàng)新互聯(lián)專(zhuān)注于企業(yè)全網(wǎng)整合營(yíng)銷(xiāo)推廣、網(wǎng)站重做改版、柳州網(wǎng)站定制設(shè)計(jì)、自適應(yīng)品牌網(wǎng)站建設(shè)、HTML5建站、電子商務(wù)商城網(wǎng)站建設(shè)、集團(tuán)公司官網(wǎng)建設(shè)、成都外貿(mào)網(wǎng)站制作、高端網(wǎng)站制作、響應(yīng)式網(wǎng)頁(yè)設(shè)計(jì)等建站業(yè)務(wù)，價(jià)格優(yōu)惠性價(jià)比高，為柳州等各大城市提供網(wǎng)站開(kāi)發(fā)制作服務(wù)。

(1) 類(lèi)名首字母應(yīng)該大寫(xiě)。字段、方法以及對(duì)象（句柄）的首字母應(yīng)小寫(xiě)。對(duì)于所有標(biāo)識(shí)符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫(xiě)中間單詞的首字母。例如：

ThisIsAClassName

thisIsMethodOrFieldName

若在定義中出現(xiàn)了常數(shù)初始化字符，則大寫(xiě)static final基本類(lèi)型標(biāo)識(shí)符中的所有字母。這樣便可標(biāo)志出它們屬于編譯期的常數(shù)。

Java包（Package）屬于一種特殊情況：它們?nèi)际切?xiě)字母，即便中間的單詞亦是如此。對(duì)于域名擴(kuò)展名稱(chēng)，如com，org，net或者edu等，全部都應(yīng)小寫(xiě)（這也是Java 1.1和Java 1.2的區(qū)別之一）。

(2) 為了常規(guī)用途而創(chuàng)建一個(gè)類(lèi)時(shí)，請(qǐng)采取"經(jīng)典形式"，并包含對(duì)下述元素的定義：

equals()

hashCode()

toString()

clone()（implement Cloneable）

implement Serializable

(3) 對(duì)于自己創(chuàng)建的每一個(gè)類(lèi)，都考慮置入一個(gè)main()，其中包含了用于測(cè)試那個(gè)類(lèi)的代碼。為使用一個(gè)項(xiàng)目中的類(lèi)，我們沒(méi)必要?jiǎng)h除測(cè)試代碼。若進(jìn)行了任何形式的改動(dòng)，可方便地返回測(cè)試。這些代碼也可作為如何使用類(lèi)的一個(gè)示例使用。

(4) 應(yīng)將方法設(shè)計(jì)成簡(jiǎn)要的、功能性單元，用它描述和實(shí)現(xiàn)一個(gè)不連續(xù)的類(lèi)接口部分。理想情況下，方法應(yīng)簡(jiǎn)明扼要。若長(zhǎng)度很大，可考慮通過(guò)某種方式將其分割成較短的幾個(gè)方法。這樣做也便于類(lèi)內(nèi)代碼的重復(fù)使用（有些時(shí)候，方法必須非常大，但它們?nèi)詰?yīng)只做同樣的一件事情）。

(5) 設(shè)計(jì)一個(gè)類(lèi)時(shí)，請(qǐng)?jiān)O(shè)身處地為客戶程序員考慮一下（類(lèi)的使用方法應(yīng)該是非常明確的）。然后，再設(shè)身處地為管理代碼的人考慮一下（預(yù)計(jì)有可能進(jìn)行哪些形式的修改，想想用什么方法可把它們變得更簡(jiǎn)單）。

(6) 使類(lèi)盡可能短小精悍，而且只解決一個(gè)特定的問(wèn)題。下面是對(duì)類(lèi)設(shè)計(jì)的一些建議：

■一個(gè)復(fù)雜的開(kāi)關(guān)語(yǔ)句：考慮采用"多形"機(jī)制

■數(shù)量眾多的方法涉及到類(lèi)型差別極大的操作：考慮用幾個(gè)類(lèi)來(lái)分別實(shí)現(xiàn)

■許多成員變量在特征上有很大的差別：考慮使用幾個(gè)類(lèi)

(7) 讓一切東西都盡可能地"私有"--private。可使庫(kù)的某一部分"公共化"（一個(gè)方法、類(lèi)或者一個(gè)字段等等），就永遠(yuǎn)不能把它拿出。若強(qiáng)行拿出，就可能破壞其他人現(xiàn)有的代碼，使他們不得不重新編寫(xiě)和設(shè)計(jì)。若只公布自己必須公布的，就可放心大膽地改變其他任何東西。在多線程環(huán)境中，隱私是特別重要的一個(gè)因素--只有private字段才能在非同步使用的情況下受到保護(hù)。

(8) 謹(jǐn)惕"巨大對(duì)象綜合癥"。對(duì)一些習(xí)慣于順序編程思維、且初涉OOP領(lǐng)域的新手，往往喜歡先寫(xiě)一個(gè)順序執(zhí)行的程序，再把它嵌入一個(gè)或兩個(gè)巨大的對(duì)象里。根據(jù)編程原理，對(duì)象表達(dá)的應(yīng)該是應(yīng)用程序的概念，而非應(yīng)用程序本身。

(9) 若不得已進(jìn)行一些不太雅觀的編程，至少應(yīng)該把那些代碼置于一個(gè)類(lèi)的內(nèi)部。

(10) 任何時(shí)候只要發(fā)現(xiàn)類(lèi)與類(lèi)之間結(jié)合得非常緊密，就需要考慮是否采用內(nèi)部類(lèi)，從而改善編碼及維護(hù)工作（參見(jiàn)第14章14.1.2小節(jié)的"用內(nèi)部類(lèi)改進(jìn)代碼"）。

(11) 盡可能細(xì)致地加上注釋?zhuān)⒂胘avadoc注釋文檔語(yǔ)法生成自己的程序文檔。

(12) 避免使用"魔術(shù)數(shù)字"，這些數(shù)字很難與代碼很好地配合。如以后需要修改它，無(wú)疑會(huì)成為一場(chǎng)噩夢(mèng)，因?yàn)楦静恢?100"到底是指"數(shù)組大小"還是"其他全然不同的東西"。所以，我們應(yīng)創(chuàng)建一個(gè)常數(shù)，并為其使用具有說(shuō)服力的描述性名稱(chēng)，并在整個(gè)程序中都采用常數(shù)標(biāo)識(shí)符。這樣可使程序更易理解以及更易維護(hù)。

(13) 涉及構(gòu)建器和異常的時(shí)候，通常希望重新丟棄在構(gòu)建器中捕獲的任何異常--如果它造成了那個(gè)對(duì)象的創(chuàng)建失敗。這樣一來(lái)，調(diào)用者就不會(huì)以為那個(gè)對(duì)象已正確地創(chuàng)建，從而盲目地繼續(xù)。

(14) 當(dāng)客戶程序員用完對(duì)象以后，若你的類(lèi)要求進(jìn)行任何清除工作，可考慮將清除代碼置于一個(gè)良好定義的方法里，采用類(lèi)似于cleanup()這樣的名字，明確表明自己的用途。除此以外，可在類(lèi)內(nèi)放置一個(gè)boolean（布爾）標(biāo)記，指出對(duì)象是否已被清除。在類(lèi)的finalize()方法里，請(qǐng)確定對(duì)象已被清除，并已丟棄了從RuntimeException繼承的一個(gè)類(lèi)（如果還沒(méi)有的話），從而指出一個(gè)編程錯(cuò)誤。在采取象這樣的方案之前，請(qǐng)確定finalize()能夠在自己的系統(tǒng)中工作（可能需要調(diào)用System.runFinalizersOnExit(true)，從而確保這一行為）。

(15) 在一個(gè)特定的作用域內(nèi)，若一個(gè)對(duì)象必須清除（非由垃圾收集機(jī)制處理），請(qǐng)采用下述方法：初始化對(duì)象；若成功，則立即進(jìn)入一個(gè)含有finally從句的try塊，開(kāi)始清除工作。

(16) 若在初始化過(guò)程中需要覆蓋（取消）finalize()，請(qǐng)記住調(diào)用super.finalize()（若Object屬于我們的直接超類(lèi)，則無(wú)此必要）。在對(duì)finalize()進(jìn)行覆蓋的過(guò)程中，對(duì)super.finalize()的調(diào)用應(yīng)屬于最后一個(gè)行動(dòng)，而不應(yīng)是第一個(gè)行動(dòng)，這樣可確保在需要基礎(chǔ)類(lèi)組件的時(shí)候它們依然有效。

(17) 創(chuàng)建大小固定的對(duì)象集合時(shí)，請(qǐng)將它們傳輸至一個(gè)數(shù)組（若準(zhǔn)備從一個(gè)方法里返回這個(gè)集合，更應(yīng)如此操作）。這樣一來(lái)，我們就可享受到數(shù)組在編譯期進(jìn)行類(lèi)型檢查的好處。此外，為使用它們，數(shù)組的接收者也許并不需要將對(duì)象"造型"到數(shù)組里。

(18) 盡量使用interfaces，不要使用abstract類(lèi)。若已知某樣?xùn)|西準(zhǔn)備成為一個(gè)基礎(chǔ)類(lèi)，那么第一個(gè)選擇應(yīng)是將其變成一個(gè)interface（接口）。只有在不得不使用方法定義或者成員變量的時(shí)候，才需要將其變成一個(gè)abstract（抽象）類(lèi)。接口主要描述了客戶希望做什么事情，而一個(gè)類(lèi)則致力于（或允許）具體的實(shí)施細(xì)節(jié)。

(19) 在構(gòu)建器內(nèi)部，只進(jìn)行那些將對(duì)象設(shè)為正確狀態(tài)所需的工作。盡可能地避免調(diào)用其他方法，因?yàn)槟切┓椒赡鼙黄渌烁采w或取消，從而在構(gòu)建過(guò)程中產(chǎn)生不可預(yù)知的結(jié)果（參見(jiàn)第7章的詳細(xì)說(shuō)明）。

(20) 對(duì)象不應(yīng)只是簡(jiǎn)單地容納一些數(shù)據(jù)；它們的行為也應(yīng)得到良好的定義。

(21) 在現(xiàn)成類(lèi)的基礎(chǔ)上創(chuàng)建新類(lèi)時(shí)，請(qǐng)首先選擇"新建"或"創(chuàng)作"。只有自己的設(shè)計(jì)要求必須繼承時(shí)，才應(yīng)考慮這方面的問(wèn)題。若在本來(lái)允許新建的場(chǎng)合使用了繼承，則整個(gè)設(shè)計(jì)會(huì)變得沒(méi)有必要地復(fù)雜。

(22) 用繼承及方法覆蓋來(lái)表示行為間的差異，而用字段表示狀態(tài)間的區(qū)別。一個(gè)非常極端的例子是通過(guò)對(duì)不同類(lèi)的繼承來(lái)表示顏色，這是絕對(duì)應(yīng)該避免的：應(yīng)直接使用一個(gè)"顏色"字段。

(23) 為避免編程時(shí)遇到麻煩，請(qǐng)保證在自己類(lèi)路徑指到的任何地方，每個(gè)名字都僅對(duì)應(yīng)一個(gè)類(lèi)。否則，編譯器可能先找到同名的另一個(gè)類(lèi)，并報(bào)告出錯(cuò)消息。若懷疑自己碰到了類(lèi)路徑問(wèn)題，請(qǐng)?jiān)囋囋陬?lèi)路徑的每一個(gè)起點(diǎn)，搜索一下同名的.class文件。

(24) 在Java 1.1 AWT中使用事件"適配器"時(shí)，特別容易碰到一個(gè)陷阱。若覆蓋了某個(gè)適配器方法，同時(shí)拼寫(xiě)方法沒(méi)有特別講究，最后的結(jié)果就是新添加一個(gè)方法，而不是覆蓋現(xiàn)成方法。然而，由于這樣做是完全合法的，所以不會(huì)從編譯器或運(yùn)行期系統(tǒng)獲得任何出錯(cuò)提示--只不過(guò)代碼的工作就變得不正常了。

(25) 用合理的設(shè)計(jì)方案消除"偽功能"。也就是說(shuō)，假若只需要?jiǎng)?chuàng)建類(lèi)的一個(gè)對(duì)象，就不要提前限制自己使用應(yīng)用程序，并加上一條"只生成其中一個(gè)"注釋。請(qǐng)考慮將其封裝成一個(gè)"獨(dú)生子"的形式。若在主程序里有大量散亂的代碼，用于創(chuàng)建自己的對(duì)象，請(qǐng)考慮采納一種創(chuàng)造性的方案，將些代碼封裝起來(lái)。

(26) 警惕"分析癱瘓"。請(qǐng)記住，無(wú)論如何都要提前了解整個(gè)項(xiàng)目的狀況，再去考察其中的細(xì)節(jié)。由于把握了全局，可快速認(rèn)識(shí)自己未知的一些因素，防止在考察細(xì)節(jié)的時(shí)候陷入"死邏輯"中。

(27) 警惕"過(guò)早優(yōu)化"。首先讓它運(yùn)行起來(lái)，再考慮變得更快--但只有在自己必須這樣做、而且經(jīng)證實(shí)在某部分代碼中的確存在一個(gè)性能瓶頸的時(shí)候，才應(yīng)進(jìn)行優(yōu)化。除非用專(zhuān)門(mén)的工具分析瓶頸，否則很有可能是在浪費(fèi)自己的時(shí)間。性能提升的隱含代價(jià)是自己的代碼變得難于理解，而且難于維護(hù)。

(28) 請(qǐng)記住，閱讀代碼的時(shí)間比寫(xiě)代碼的時(shí)間多得多。思路清晰的設(shè)計(jì)可獲得易于理解的程序，但注釋、細(xì)致的解釋以及一些示例往往具有不可估量的價(jià)值。無(wú)論對(duì)你自己，還是對(duì)后來(lái)的人，它們都是相當(dāng)重要的。如對(duì)此仍有懷疑，那么請(qǐng)?jiān)囅胱约涸噲D從聯(lián)機(jī)Java文檔里找出有用信息時(shí)碰到的挫折，這樣或許能將你說(shuō)服。

(29) 如認(rèn)為自己已進(jìn)行了良好的分析、設(shè)計(jì)或者實(shí)施，那么請(qǐng)稍微更換一下思維角度。試試邀請(qǐng)一些外來(lái)人士--并不一定是專(zhuān)家，但可以是來(lái)自本公司其他部門(mén)的人。請(qǐng)他們用完全新鮮的眼光考察你的工作，看看是否能找出你一度熟視無(wú)睹的問(wèn)題。采取這種方式，往往能在最適合修改的階段找出一些關(guān)鍵性的問(wèn)題，避免產(chǎn)品發(fā)行后再解決問(wèn)題而造成的金錢(qián)及精力方面的損失。

(30) 良好的設(shè)計(jì)能帶來(lái)最大的回報(bào)。簡(jiǎn)言之，對(duì)于一個(gè)特定的問(wèn)題，通常會(huì)花較長(zhǎng)的時(shí)間才能找到一種最恰當(dāng)?shù)慕鉀Q方案。但一旦找到了正確的方法，以后的工作就輕松多了，再也不用經(jīng)歷數(shù)小時(shí)、數(shù)天或者數(shù)月的痛苦掙扎。我們的努力工作會(huì)帶來(lái)最大的回報(bào)（甚至無(wú)可估量）。而且由于自己傾注了大量心血，最終獲得一個(gè)出色的設(shè)計(jì)方案，成功的快感也是令人心動(dòng)的。堅(jiān)持****草草完工的誘惑--那樣做往往得不償失

Java的基本格式

基本格式：修飾符 class 類(lèi)名（程序代碼）

意義：Java中的程序代碼都必須放在一個(gè)類(lèi)中，對(duì)于類(lèi)初學(xué)者可以簡(jiǎn)單地把它理解為一個(gè)java程序；類(lèi)需要使用class作為關(guān)鍵字定義；而在class的前面可以有一些修飾符。

擴(kuò)展資料

編寫(xiě)java時(shí)，特別需要注意的幾個(gè)書(shū)寫(xiě)格式常見(jiàn)的錯(cuò)誤：

1.java中的程序代碼中功能執(zhí)行語(yǔ)句的最后都必須用（;）結(jié)束。

這里需要注意的是，在程序中不要將英文的分號(hào)（;）誤寫(xiě)成中文的分號(hào)（；） ，如果寫(xiě)成了中文的分號(hào)，編譯器會(huì)報(bào)告“Invalid character”（無(wú)效字符）這樣的錯(cuò)誤信息。

2.Java語(yǔ)言是嚴(yán)格區(qū)分大小寫(xiě)的。在定義類(lèi)時(shí)，不能將class寫(xiě)成Class，否則編譯會(huì)報(bào)錯(cuò)。程序中定義一個(gè)computer的同時(shí)，還可以定義一個(gè)Computer，computer和Computer是兩個(gè)全完不同的符號(hào)，在使用的時(shí)候需要注意。

3. 在編寫(xiě)java代碼的時(shí)候?yàn)榱吮阌陂喿x，通常會(huì)使用一種良好的格式進(jìn)行排版，但這并不是必須的，我們也可以在兩個(gè)單詞或者符號(hào)之間任意換行。

參考資料：百度百科-java

java程序員有哪些應(yīng)該注意的編碼規(guī)范?

Java編碼規(guī)范:　盡量使用完整的英文描述符采用適用于相關(guān)領(lǐng)域的術(shù)語(yǔ)采用大小寫(xiě)混合使名字可讀盡量少用縮寫(xiě)，但如果用了，必須符合整個(gè)工程中的統(tǒng)一定義避免使用長(zhǎng)的名字（小于15個(gè)字母為正常選擇）避免使用類(lèi)似的名字，或者僅僅是大小寫(xiě)不同的名字避免使用下劃線（除靜態(tài)常量等）標(biāo)識(shí)符類(lèi)型說(shuō)明包（Package）的命名Package的名字應(yīng)該采用完整的英文描述符，都是由一個(gè)小寫(xiě)單詞組成。并且包名的前綴總是一個(gè)頂級(jí)域名

，通常是com、edu、gov、mil、net、org等；如：com.yjhmily.test類(lèi)（Class）的命名類(lèi)名應(yīng)該是個(gè)一名詞，采用大小寫(xiě)混合的方式，每個(gè)單詞的首字母大寫(xiě)。盡量保證類(lèi)名簡(jiǎn)潔而富于描述。

北大青鳥(niǎo)java培訓(xùn)：如何規(guī)范自己的代碼編輯方式？

對(duì)于程序員來(lái)說(shuō)，養(yǎng)成良好的代碼寫(xiě)作能力是非常重要的。

今天，我們就一起來(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ě)的注釋?zhuān)ニ锌崭窈蛽Q行，甚至可以把原來(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ě)完整注釋?zhuān)哺奖銏F(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)在看不太懂了，那還真是天大的笑話了。

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ì)，除了以上兩種之外，還有第三種，文檔注釋?zhuān)?/p>

/** ...... */ 注釋若干行，并寫(xiě)入 javadoc 文檔

注釋要簡(jiǎn)單明了。

String userName = null; //用戶名

邊寫(xiě)代碼邊注釋?zhuān)薷拇a同時(shí)修改相應(yīng)的注釋?zhuān)员ＷC注釋與代碼的一致性。

在必要的地方注釋?zhuān)⑨屃恳m中。注釋的內(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ì)的注釋?zhuān)▽?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ò)程名稱(chēng)；功能描述；輸入、輸出及返回值說(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ì)類(lèi)的說(shuō)明 標(biāo)明開(kāi)發(fā)該類(lèi)模塊的作者

@version 對(duì)類(lèi)的說(shuō)明 標(biāo)明該類(lèi)模塊的版本

@see 對(duì)類(lèi)、屬性、方法的說(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)的注釋?zhuān)话闶怯脕?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)是類(lèi)定義，包含了在不同的行的 extends 和 implements

public class CounterSet

extends Observable

implements Cloneable

Class Fields

接下來(lái)是類(lèi)的成員變量：

/**

* Packet counters

*/

protected int[] packets;

public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義的成

員變量如果名字含義明確的話，可以沒(méi)有注釋。

存取方法

接下來(lái)是類(lèi)變量的存取的方法。它只是簡(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); }

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)類(lèi)型 (public, private 等.) 和 任何 static, final 或 synchronized 應(yīng)該在一行

中，并且方法和參數(shù)另寫(xiě)一行，這樣可以使方法和參數(shù)更易讀。

public

CounterSet(int size){

this.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());

}

}

類(lèi)方法

下面開(kāi)始寫(xiě)類(lèi)的方法：

/**

* 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è)類(lèi)都應(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ě)在類(lèi)的底部.

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 類(lèi)，StringBuffer 類(lèi)是構(gòu)成 String 類(lèi)的基礎(chǔ)。

String 類(lèi)將 StringBuffer 類(lèi)封裝了起來(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 類(lèi)

Utility 類(lèi)（僅僅提供方法的類(lèi)）應(yīng)該被申明為抽象的來(lái)防止被繼承或被初始化。

初始化

下面的代碼是一種很好的初始化數(shù)組的方法：

objectArguments = new Object[] { arguments };

枚舉類(lèi)型

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)型一樣使用的常量。

他們可以用 '==' 操作符來(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 的（比如：回車(chē)變成回車(chē)+換行）

文檔化

必須用 javadoc 來(lái)為類(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)代替它。

新聞名稱(chēng)：java規(guī)范代碼格式 Java編碼格式
網(wǎng)頁(yè)路徑：http://muchs.cn/article24/hgejje.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供Google、網(wǎng)站策劃、ChatGPT、網(wǎng)站維護(hù)、關(guān)鍵詞優(yōu)化、App設(shè)計(jì)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)