對于程序員來說,養(yǎng)成良好的代碼寫作能力是非常重要的。
成都創(chuàng)新互聯(lián)從2013年開始,是專業(yè)互聯(lián)網(wǎng)技術(shù)服務(wù)公司,擁有項目網(wǎng)站設(shè)計制作、網(wǎng)站設(shè)計網(wǎng)站策劃,項目實施與項目整合能力。我們以讓每一個夢想脫穎而出為使命,1280元馬村做網(wǎng)站,已為上家服務(wù),為馬村各地企業(yè)和個人服務(wù),聯(lián)系電話:028-86922220
今天,我們就一起來了解一下,規(guī)范化的代碼編寫都有哪些要求。
希望通過對本文的閱讀,能夠提高大家對于代碼規(guī)范的認(rèn)識。
1.保證代碼壓縮后不出錯對于大型的JSP項目,一般會在產(chǎn)品發(fā)布時對項目包含的所有JSP文件進(jìn)行壓縮處理,比如可以利用GoogleClosureCompilerService對代碼進(jìn)行壓縮,新版jQuery已改用這一工具對代碼進(jìn)行壓縮,這一般會去掉開發(fā)時寫的注釋,除去所有空格和換行,甚至可以把原來較長的變量名替換成短且無意義的變量名,這樣做的目的是加快文件的下載速度,同時也減小網(wǎng)站訪問帶來的額外數(shù)據(jù)流量,另外在代碼保護(hù)上也起到了一點點作用,至少壓縮后的代碼即使被還原還是沒那么容易一下讀懂的。
要想代碼能正確通過壓縮,一般要求語句都要以分號正常結(jié)束,大括號也要嚴(yán)格結(jié)束等,具體還要看壓縮工具的要求。
所以如果一開始沒有按標(biāo)準(zhǔn)來做,等壓縮出錯后再回去找錯誤那是浪費時間。
2.保證代碼能通過特定IDE的自動格式化功能一般較為完善的開發(fā)工具(比如AptanaStudio)都有代碼"自動格式"化功能,這一功能幫助實現(xiàn)統(tǒng)一換行、縮進(jìn)、空格等代碼編排,你可以設(shè)置自己喜歡的格式標(biāo)準(zhǔn),比如左大括號{是否另起一行。
達(dá)到這個要求的目的在于方便你的開發(fā)團(tuán)隊成員拿你代碼的一個副本用IDE自動格式化成他喜歡或熟悉的風(fēng)格進(jìn)行閱讀。
你同事需要閱讀你的代碼,可能是因為你寫的是通用方法,他在其它模塊開發(fā)過程中也要使用到,閱讀你的代碼能深入了解方法調(diào)用和實現(xiàn)的細(xì)節(jié),這是簡單API文檔不能達(dá)到的效果。
3.使用標(biāo)準(zhǔn)的文檔注釋這一要求算是基本的,這有利于在方法調(diào)用處看到方法的具體傳參提示,也可以利用配套文檔工具生成html或其它格式的開發(fā)文檔供其他團(tuán)隊成員閱讀,你可以嘗試使用jsdoc-toolkit。
如果你自動生成的API是出自一個開放平臺,就像facebook.com應(yīng)用,那么你的文檔是給天下所有開發(fā)者看的。
另外編寫完整注釋,也更方便團(tuán)隊成員閱讀你的代碼,通過你的參數(shù)描述,團(tuán)隊成員可以很容易知道你編寫的方法傳參與實現(xiàn)細(xì)節(jié)。
當(dāng)然也方便日后代碼維護(hù),這樣即使再大的項目,過了很長時間后,回去改點東西也就不至于自己都忘記了當(dāng)時自己寫的代碼是怎么一回事了。
4.使用規(guī)范有意義的變量名使用規(guī)范有意義的變量名可以提高代碼的可讀性,作為大項目開發(fā)成員,自己寫的代碼不僅僅要讓別人容易看懂。
電腦培訓(xùn)認(rèn)為開發(fā)大項目,其實每個人寫的代碼量可能都比較大,規(guī)范命名,日后自己看回自己的代碼也顯的清晰易懂,比如日后系統(tǒng)升級或新增功能,修改起代碼來也輕松多了。
如果到頭發(fā)現(xiàn)自己當(dāng)初寫的代碼現(xiàn)在看不太懂了,那還真是天大的笑話了。
靜態(tài)測試包括代碼檢查、靜態(tài)結(jié)構(gòu)分析、代碼質(zhì)量度量等。它可以由人工進(jìn)行,充分發(fā)揮人的邏輯思維優(yōu)勢,也可以借助軟件工具自動進(jìn)行。代碼檢查代碼檢查包括代碼走查、桌面檢查、代碼審查等,主要檢查代碼和設(shè)計的一致性, 代碼對標(biāo)準(zhǔn)的遵循、可讀性,代碼的邏輯表達(dá)的正確性,代碼結(jié)構(gòu)的合理性等方面;可以發(fā)現(xiàn)違背程序編寫標(biāo)準(zhǔn)的問題,程序中不安全、不明確和模糊的部分,找出程序中不可移植部分、違背程序編程風(fēng)格的問題,包括變量檢查、命名和類型審查、程序邏輯審查、程序語法檢查和程序結(jié)構(gòu)檢查等內(nèi)容?!薄?戳艘幌盗械撵o態(tài)代碼掃描或者叫靜態(tài)代碼分析工具后,總結(jié)對工具的看法:靜態(tài)代碼掃描工具,和編譯器的某些功能其實是很相似的,他們也需要詞法分析,語法分析,語意分析...但和編譯器不一樣的是他們可以自定義各種各樣的復(fù)雜的規(guī)則去對代碼進(jìn)行分析。
對于每個程序員來說,養(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)進(jìn)行時,在發(fā)生壓縮錯誤后再次尋找錯誤是浪費時間的。
二、保證代碼能夠通過自動格式化功能一般情況下需要使用完善的開發(fā)工具進(jìn)行自動化格式功能,這個功能能夠進(jìn)行換行、縮進(jìn)和空格等方法的代碼編排,并且還可以設(shè)置自己喜歡的格式。
別人在閱讀你的代碼時需要使用IDE進(jìn)行格式轉(zhuǎn)換,以滿足個人的閱讀風(fēng)格。
北京北大青鳥認(rèn)為閱讀代碼能夠更加深入的了解代碼調(diào)用和細(xì)節(jié)的實現(xiàn),這是簡單的文檔不能實現(xiàn)的。
三、使用標(biāo)準(zhǔn)的文檔注釋這是編寫代碼中最基本的要求,能夠很好的了解代碼的提示,并且還可以利用配套的文檔工具生產(chǎn)其他格式讓別人閱讀。
北大青鳥認(rèn)為編寫完整的注釋還可以使團(tuán)隊成員更容易閱讀您的代碼。
通過您的參數(shù)描述,團(tuán)隊成員很容易了解您想要傳遞參與實現(xiàn)細(xì)節(jié)和編寫的方法。
Checkstyle
這個可以自定義規(guī)范,如變量的命名規(guī)范,方法的命名的規(guī)范,一行代碼的字?jǐn)?shù),一個方法的行數(shù),是否已經(jīng)加注釋等等
文章題目:java如何檢查代碼規(guī)范 java查詢系統(tǒng)代碼
鏈接分享:http://jinyejixie.com/article12/ddcogdc.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站維護(hù)、網(wǎng)站建設(shè)、搜索引擎優(yōu)化、網(wǎng)站改版、網(wǎng)站導(dǎo)航、小程序開發(fā)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)