新聞中心
北大青鳥java培訓(xùn):如何規(guī)范自己的代碼編輯方式?
對于程序員來說,養(yǎng)成良好的代碼寫作能力是非常重要的。
創(chuàng)新互聯(lián)堅持“要么做到,要么別承諾”的工作理念,服務(wù)領(lǐng)域包括:網(wǎng)站建設(shè)、成都網(wǎng)站制作、企業(yè)官網(wǎng)、英文網(wǎng)站、手機端網(wǎng)站、網(wǎng)站推廣等服務(wù),滿足客戶于互聯(lián)網(wǎng)時代的鼓樓網(wǎng)站設(shè)計、移動媒體設(shè)計的需求,幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴!
今天,我們就一起來了解一下,規(guī)范化的代碼編寫都有哪些要求。
希望通過對本文的閱讀,能夠提高大家對于代碼規(guī)范的認(rèn)識。
1.保證代碼壓縮后不出錯對于大型的JSP項目,一般會在產(chǎn)品發(fā)布時對項目包含的所有JSP文件進行壓縮處理,比如可以利用GoogleClosureCompilerService對代碼進行壓縮,新版jQuery已改用這一工具對代碼進行壓縮,這一般會去掉開發(fā)時寫的注釋,除去所有空格和換行,甚至可以把原來較長的變量名替換成短且無意義的變量名,這樣做的目的是加快文件的下載速度,同時也減小網(wǎng)站訪問帶來的額外數(shù)據(jù)流量,另外在代碼保護上也起到了一點點作用,至少壓縮后的代碼即使被還原還是沒那么容易一下讀懂的。
要想代碼能正確通過壓縮,一般要求語句都要以分號正常結(jié)束,大括號也要嚴(yán)格結(jié)束等,具體還要看壓縮工具的要求。
所以如果一開始沒有按標(biāo)準(zhǔn)來做,等壓縮出錯后再回去找錯誤那是浪費時間。
2.保證代碼能通過特定IDE的自動格式化功能一般較為完善的開發(fā)工具(比如AptanaStudio)都有代碼"自動格式"化功能,這一功能幫助實現(xiàn)統(tǒng)一換行、縮進、空格等代碼編排,你可以設(shè)置自己喜歡的格式標(biāo)準(zhǔn),比如左大括號{是否另起一行。
達到這個要求的目的在于方便你的開發(fā)團隊成員拿你代碼的一個副本用IDE自動格式化成他喜歡或熟悉的風(fēng)格進行閱讀。
你同事需要閱讀你的代碼,可能是因為你寫的是通用方法,他在其它模塊開發(fā)過程中也要使用到,閱讀你的代碼能深入了解方法調(diào)用和實現(xiàn)的細(xì)節(jié),這是簡單API文檔不能達到的效果。
3.使用標(biāo)準(zhǔn)的文檔注釋這一要求算是基本的,這有利于在方法調(diào)用處看到方法的具體傳參提示,也可以利用配套文檔工具生成html或其它格式的開發(fā)文檔供其他團隊成員閱讀,你可以嘗試使用jsdoc-toolkit。
如果你自動生成的API是出自一個開放平臺,就像facebook點抗 應(yīng)用,那么你的文檔是給天下所有開發(fā)者看的。
另外編寫完整注釋,也更方便團隊成員閱讀你的代碼,通過你的參數(shù)描述,團隊成員可以很容易知道你編寫的方法傳參與實現(xiàn)細(xì)節(jié)。
當(dāng)然也方便日后代碼維護,這樣即使再大的項目,過了很長時間后,回去改點東西也就不至于自己都忘記了當(dāng)時自己寫的代碼是怎么一回事了。
4.使用規(guī)范有意義的變量名使用規(guī)范有意義的變量名可以提高代碼的可讀性,作為大項目開發(fā)成員,自己寫的代碼不僅僅要讓別人容易看懂。
電腦培訓(xùn)認(rèn)為開發(fā)大項目,其實每個人寫的代碼量可能都比較大,規(guī)范命名,日后自己看回自己的代碼也顯的清晰易懂,比如日后系統(tǒng)升級或新增功能,修改起代碼來也輕松多了。
如果到頭發(fā)現(xiàn)自己當(dāng)初寫的代碼現(xiàn)在看不太懂了,那還真是天大的笑話了。
北大青鳥java培訓(xùn):程序員如何規(guī)范代碼的編寫方法?
對于每個程序員來說,養(yǎng)成良好的代碼編寫方法是非常關(guān)鍵的。
在編寫代碼的過程中,每個人的方法是不同的,那么應(yīng)該如何規(guī)范自己代碼編寫的方法呢?規(guī)范編寫代碼有哪些要求呢?下面電腦培訓(xùn)帶大家認(rèn)識代碼編寫的方法。
一、保證代碼壓縮后不會出錯對于大的JavaScript項目,一般來說,包含在項目中的所有JavaScript文件在產(chǎn)品公開時都會被壓縮。
為了正確壓縮代碼,通常需要考慮壓縮工具的必要條件,如句子用分號正常結(jié)束,中括號結(jié)束等。
因此,IT培訓(xùn)發(fā)現(xiàn)當(dāng)編寫代碼沒有按照標(biāo)準(zhǔn)進行時,在發(fā)生壓縮錯誤后再次尋找錯誤是浪費時間的。
二、保證代碼能夠通過自動格式化功能一般情況下需要使用完善的開發(fā)工具進行自動化格式功能,這個功能能夠進行換行、縮進和空格等方法的代碼編排,并且還可以設(shè)置自己喜歡的格式。
別人在閱讀你的代碼時需要使用IDE進行格式轉(zhuǎn)換,以滿足個人的閱讀風(fēng)格。
福建北大青鳥認(rèn)為閱讀代碼能夠更加深入的了解代碼調(diào)用和細(xì)節(jié)的實現(xiàn),這是簡單的文檔不能實現(xiàn)的。
三、使用標(biāo)準(zhǔn)的文檔注釋這是編寫代碼中最基本的要求,能夠很好的了解代碼的提示,并且還可以利用配套的文檔工具生產(chǎn)其他格式讓別人閱讀。
北大青鳥認(rèn)為編寫完整的注釋還可以使團隊成員更容易閱讀您的代碼。
通過您的參數(shù)描述,團隊成員很容易了解您想要傳遞參與實現(xiàn)細(xì)節(jié)和編寫的方法。
為什么要遵守Java代碼規(guī)范?
在進行Java代碼敲寫的時候,我們知道是有很多的Java代碼規(guī)范是需要遵守的,但是有的Java學(xué)員就老是忘記,還有的Java學(xué)員是不屑遵守的,內(nèi)心想著是只要我的Java代碼OK,遵不遵守Java代碼規(guī)范,有什么問題呢?其實是存在問題的,為什么要遵守Java代碼規(guī)范?
為什么要遵守Java代碼規(guī)范?當(dāng)你第一次接觸到Java代碼規(guī)范的時候,你是不是覺得很麻煩呢?比如關(guān)于統(tǒng)一的原則,一再的強調(diào),但是你一再的忘記,或者壓根就不想照做,會出現(xiàn)什么樣的后果呢?今天云南java培訓(xùn)將借Java代碼規(guī)范中的統(tǒng)一來說說,自己對為什么要遵守Java代碼規(guī)范,發(fā)表自己簡單的看法。
Java代碼規(guī)范中的統(tǒng)一是指,對于同一個概念,在程序中用同一種表示方法,比如對于供應(yīng)商,既可以用supplier,也可以用provider,但是我們只能選定一個使用,至少在一個Java項目中保持統(tǒng)一。統(tǒng)一是作為重要的,如果對同一概念有不同的表示方法,會使代碼混亂難以理解。即使不能取得好的名稱,但是只要統(tǒng)一,閱讀起來也不會太困難,因為閱讀者只要理解一次。
而如果你在一個項目中不遵守已經(jīng)制定好的統(tǒng)一規(guī)范,那么不僅是給自己帶來麻煩,也是給其他工作人員帶來不便,在要進行整理的時候,你的不同,會帶來不必要的交流麻煩。作為一個Java程序員,你一般是屬于團隊中的一員,你不遵守制定好的Java代碼規(guī)范,其他人也不遵守那么你們的團隊就得亂套了,所以面對Java代碼規(guī)范的學(xué)習(xí),不要覺得無趣,還是得用心記住,并且予以遵守。
java編碼規(guī)范有哪些?
盡量使用完整的英文描述符,采用適用于相關(guān)領(lǐng)域的術(shù)語,采用大小寫混合使名字可讀。
JAVA代碼規(guī)范:
(1)類名首字母應(yīng)該大寫。字段、方法以及對象(句柄)的首字母應(yīng)小寫。對于所有標(biāo)識符,其中包含的所有單詞都應(yīng)緊靠在一起,而且大寫中間單詞的首字母。例如:
ThisIsAClassName
thisIsMethodOrFieldName
若在定義中出現(xiàn)了常數(shù)初始化字符,則大寫static final基本類型標(biāo)識符中的所有字母。這樣便可標(biāo)志出它們屬于編譯期的常數(shù)。Java包(Package)屬于一種特殊情況:它們?nèi)际切懽帜?,即便中間的單詞亦是如此。對于域名擴展名稱,如com,org,net或者edu等,全部都應(yīng)小寫(這也是Java1.1和Java1.2的區(qū)別之一)。
(2)為了常規(guī)用途而創(chuàng)建一個類時,請采取"經(jīng)典形式",并包含對下述元素的定義:equals()
hashCode()
toString()
clone()(implement Cloneable)
implement Serializable
(3)對于自己創(chuàng)建的每一個類,都考慮置入一個main(),其中包含了用于測試那個類的代碼。為使用一個項目中的類,我們沒必要刪除測試代碼。若進行了任何形式的改動,可方便地返回測試。這些代碼也可作為如何使用類的一個示例使用。
(4)應(yīng)將方法設(shè)計成簡要的、功能性單元,用它描述和實現(xiàn)一個不連續(xù)的類接口部分。理想情況下,方法應(yīng)簡明扼要。若長度很大,可考慮通過某種方式將其分割成較短的幾個方法。這樣做也便于類內(nèi)代碼的重復(fù)使用(有些時候,方法必須非常大,但它們?nèi)詰?yīng)只做同樣的一件事情)。
(5)設(shè)計一個類時,請設(shè)身處地為客戶程序員考慮一下(類的使用方法應(yīng)該是非常明確的)。然后,再設(shè)身處地為管理代碼的人考慮一下(預(yù)計有可能進行哪些形式的修改,想想用什么方法可把它們變得更簡單)。
(6)使類盡可能短小精悍,而且只解決一個特定的問題。下面是對類設(shè)計的一些建議:
一個復(fù)雜的開關(guān)語句:考慮采用"多形"機制
數(shù)量眾多的方法涉及到類型差別極大的操作:考慮用幾個類來分別實現(xiàn)
許多成員變量在特征上有很大的差別:考慮使用幾個類
(7)讓一切東西都盡可能地"私有"-private??墒箮斓哪骋徊糠?公共化"(一個方法、類或者一個字段等等),就永遠(yuǎn)不能把它拿出。若強行拿出,就可能破壞其他人現(xiàn)有的代碼,使他們不得不重新編寫和設(shè)計。若只公布自己必須公布的,就可放心大膽地改變其他任何東西。在多線程環(huán)境中,隱私是特別重要的一個因素-只有private字段才能在非同步使用的情況下受到保護。
(8)謹(jǐn)惕"巨大對象綜合癥。對一些習(xí)慣于順序編程思維、且初涉OOP領(lǐng)域的新手,往往喜歡先寫一個順序執(zhí)行的程序,再把它嵌入一個或兩個巨大的對象里。根據(jù)編程原理,對象表達的應(yīng)該是應(yīng)用程序的概念。
本文題目:代碼規(guī)范java 代碼規(guī)范檢查工具
文章分享:http://ef60e0e.cn/article/ddsgigg.html