在進(jìn)行Java代碼敲寫的時(shí)候,我們知道是有很多的Java代碼規(guī)范是需要遵守的,但是有的Java學(xué)員就老是忘記,還有的Java學(xué)員是不屑遵守的,內(nèi)心想著是只要我的Java代碼OK,遵不遵守Java代碼規(guī)范,有什么問題呢?其實(shí)是存在問題的,為什么要遵守Java代碼規(guī)范?
成都創(chuàng)新互聯(lián)堅(jiān)持“要么做到,要么別承諾”的工作理念,服務(wù)領(lǐng)域包括:網(wǎng)站制作、網(wǎng)站設(shè)計(jì)、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣等服務(wù),滿足客戶于互聯(lián)網(wǎng)時(shí)代的金州網(wǎng)站設(shè)計(jì)、移動(dòng)媒體設(shè)計(jì)的需求,幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴!
為什么要遵守Java代碼規(guī)范?當(dāng)你第一次接觸到Java代碼規(guī)范的時(shí)候,你是不是覺得很麻煩呢?比如關(guān)于統(tǒng)一的原則,一再的強(qiáng)調(diào),但是你一再的忘記,或者壓根就不想照做,會(huì)出現(xiàn)什么樣的后果呢?今天云南java培訓(xùn)將借Java代碼規(guī)范中的統(tǒng)一來說說,自己對為什么要遵守Java代碼規(guī)范,發(fā)表自己簡單的看法。
Java代碼規(guī)范中的統(tǒng)一是指,對于同一個(gè)概念,在程序中用同一種表示方法,比如對于供應(yīng)商,既可以用supplier,也可以用provider,但是我們只能選定一個(gè)使用,至少在一個(gè)Java項(xiàng)目中保持統(tǒng)一。統(tǒng)一是作為重要的,如果對同一概念有不同的表示方法,會(huì)使代碼混亂難以理解。即使不能取得好的名稱,但是只要統(tǒng)一,閱讀起來也不會(huì)太困難,因?yàn)殚喿x者只要理解一次。
而如果你在一個(gè)項(xiàng)目中不遵守已經(jīng)制定好的統(tǒng)一規(guī)范,那么不僅是給自己帶來麻煩,也是給其他工作人員帶來不便,在要進(jìn)行整理的時(shí)候,你的不同,會(huì)帶來不必要的交流麻煩。作為一個(gè)Java程序員,你一般是屬于團(tuán)隊(duì)中的一員,你不遵守制定好的Java代碼規(guī)范,其他人也不遵守那么你們的團(tuán)隊(duì)就得亂套了,所以面對Java代碼規(guī)范的學(xué)習(xí),不要覺得無趣,還是得用心記住,并且予以遵守。
對于程序員來說,養(yǎng)成良好的代碼寫作能力是非常重要的。
今天,我們就一起來了解一下,規(guī)范化的代碼編寫都有哪些要求。
希望通過對本文的閱讀,能夠提高大家對于代碼規(guī)范的認(rèn)識。
1.保證代碼壓縮后不出錯(cuò)對于大型的JSP項(xiàng)目,一般會(huì)在產(chǎn)品發(fā)布時(shí)對項(xiàng)目包含的所有JSP文件進(jìn)行壓縮處理,比如可以利用GoogleClosureCompilerService對代碼進(jìn)行壓縮,新版jQuery已改用這一工具對代碼進(jìn)行壓縮,這一般會(huì)去掉開發(fā)時(shí)寫的注釋,除去所有空格和換行,甚至可以把原來較長的變量名替換成短且無意義的變量名,這樣做的目的是加快文件的下載速度,同時(shí)也減小網(wǎng)站訪問帶來的額外數(shù)據(jù)流量,另外在代碼保護(hù)上也起到了一點(diǎn)點(diǎn)作用,至少壓縮后的代碼即使被還原還是沒那么容易一下讀懂的。
要想代碼能正確通過壓縮,一般要求語句都要以分號正常結(jié)束,大括號也要嚴(yán)格結(jié)束等,具體還要看壓縮工具的要求。
所以如果一開始沒有按標(biāo)準(zhǔn)來做,等壓縮出錯(cuò)后再回去找錯(cuò)誤那是浪費(fèi)時(shí)間。
2.保證代碼能通過特定IDE的自動(dòng)格式化功能一般較為完善的開發(fā)工具(比如AptanaStudio)都有代碼"自動(dòng)格式"化功能,這一功能幫助實(shí)現(xiàn)統(tǒng)一換行、縮進(jìn)、空格等代碼編排,你可以設(shè)置自己喜歡的格式標(biāo)準(zhǔn),比如左大括號{是否另起一行。
達(dá)到這個(gè)要求的目的在于方便你的開發(fā)團(tuán)隊(duì)成員拿你代碼的一個(gè)副本用IDE自動(dòng)格式化成他喜歡或熟悉的風(fēng)格進(jìn)行閱讀。
你同事需要閱讀你的代碼,可能是因?yàn)槟銓懙氖峭ㄓ梅椒?,他在其它模塊開發(fā)過程中也要使用到,閱讀你的代碼能深入了解方法調(diào)用和實(shí)現(xiàn)的細(xì)節(jié),這是簡單API文檔不能達(dá)到的效果。
3.使用標(biāo)準(zhǔn)的文檔注釋這一要求算是基本的,這有利于在方法調(diào)用處看到方法的具體傳參提示,也可以利用配套文檔工具生成html或其它格式的開發(fā)文檔供其他團(tuán)隊(duì)成員閱讀,你可以嘗試使用jsdoc-toolkit。
如果你自動(dòng)生成的API是出自一個(gè)開放平臺,就像facebook.com應(yīng)用,那么你的文檔是給天下所有開發(fā)者看的。
另外編寫完整注釋,也更方便團(tuán)隊(duì)成員閱讀你的代碼,通過你的參數(shù)描述,團(tuán)隊(duì)成員可以很容易知道你編寫的方法傳參與實(shí)現(xiàn)細(xì)節(jié)。
當(dāng)然也方便日后代碼維護(hù),這樣即使再大的項(xiàng)目,過了很長時(shí)間后,回去改點(diǎn)東西也就不至于自己都忘記了當(dāng)時(shí)自己寫的代碼是怎么一回事了。
4.使用規(guī)范有意義的變量名使用規(guī)范有意義的變量名可以提高代碼的可讀性,作為大項(xiàng)目開發(fā)成員,自己寫的代碼不僅僅要讓別人容易看懂。
電腦培訓(xùn)認(rèn)為開發(fā)大項(xiàng)目,其實(shí)每個(gè)人寫的代碼量可能都比較大,規(guī)范命名,日后自己看回自己的代碼也顯的清晰易懂,比如日后系統(tǒng)升級或新增功能,修改起代碼來也輕松多了。
如果到頭發(fā)現(xiàn)自己當(dāng)初寫的代碼現(xiàn)在看不太懂了,那還真是天大的笑話了。
對于每個(gè)程序員來說,養(yǎng)成良好的代碼編寫方法是非常關(guān)鍵的。
在編寫代碼的過程中,每個(gè)人的方法是不同的,那么應(yīng)該如何規(guī)范自己代碼編寫的方法呢?規(guī)范編寫代碼有哪些要求呢?下面電腦培訓(xùn)帶大家認(rèn)識代碼編寫的方法。
一、保證代碼壓縮后不會(huì)出錯(cuò)對于大的JavaScript項(xiàng)目,一般來說,包含在項(xiàng)目中的所有JavaScript文件在產(chǎn)品公開時(shí)都會(huì)被壓縮。
為了正確壓縮代碼,通常需要考慮壓縮工具的必要條件,如句子用分號正常結(jié)束,中括號結(jié)束等。
因此,IT培訓(xùn)發(fā)現(xiàn)當(dāng)編寫代碼沒有按照標(biāo)準(zhǔn)進(jìn)行時(shí),在發(fā)生壓縮錯(cuò)誤后再次尋找錯(cuò)誤是浪費(fèi)時(shí)間的。
二、保證代碼能夠通過自動(dòng)格式化功能一般情況下需要使用完善的開發(fā)工具進(jìn)行自動(dòng)化格式功能,這個(gè)功能能夠進(jìn)行換行、縮進(jìn)和空格等方法的代碼編排,并且還可以設(shè)置自己喜歡的格式。
別人在閱讀你的代碼時(shí)需要使用IDE進(jìn)行格式轉(zhuǎn)換,以滿足個(gè)人的閱讀風(fēng)格。
江蘇北大青鳥認(rèn)為閱讀代碼能夠更加深入的了解代碼調(diào)用和細(xì)節(jié)的實(shí)現(xiàn),這是簡單的文檔不能實(shí)現(xiàn)的。
三、使用標(biāo)準(zhǔn)的文檔注釋這是編寫代碼中最基本的要求,能夠很好的了解代碼的提示,并且還可以利用配套的文檔工具生產(chǎn)其他格式讓別人閱讀。
北大青鳥認(rèn)為編寫完整的注釋還可以使團(tuán)隊(duì)成員更容易閱讀您的代碼。
通過您的參數(shù)描述,團(tuán)隊(duì)成員很容易了解您想要傳遞參與實(shí)現(xiàn)細(xì)節(jié)和編寫的方法。