對(duì)于每個(gè)程序員來說,養(yǎng)成良好的代碼編寫方法是非常關(guān)鍵的。

創(chuàng)新互聯(lián)建站主要從事網(wǎng)站設(shè)計(jì)、成都做網(wǎng)站、網(wǎng)頁設(shè)計(jì)、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)宛城,10多年網(wǎng)站建設(shè)經(jīng)驗(yàn),價(jià)格優(yōu)惠、服務(wù)專業(yè),歡迎來電咨詢建站服務(wù):028-86922220
在編寫代碼的過程中,每個(gè)人的方法是不同的,那么應(yīng)該如何規(guī)范自己代碼編寫的方法呢?規(guī)范編寫代碼有哪些要求呢?下面電腦培訓(xùn)帶大家認(rèn)識(shí)代碼編寫的方法。
一、保證代碼壓縮后不會(huì)出錯(cuò)對(duì)于大的JavaScript項(xiàng)目,一般來說,包含在項(xiàng)目中的所有JavaScript文件在產(chǎn)品公開時(shí)都會(huì)被壓縮。
為了正確壓縮代碼,通常需要考慮壓縮工具的必要條件,如句子用分號(hào)正常結(jié)束,中括號(hào)結(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é)和編寫的方法。
如何寫出好的Java代碼
1.
優(yōu)雅需要付出代價(jià)。從短期利益來看,對(duì)某個(gè)問題提出優(yōu)雅的解決方法,似乎可能花你更多的時(shí)間。但當(dāng)它終于能夠正確執(zhí)行并可輕易套用于新案例中,不需要花上數(shù)以時(shí)計(jì),甚至以天計(jì)或以月計(jì)的辛苦代價(jià)時(shí),你會(huì)看得到先前所花功夫的回報(bào)(即使沒有人可以衡量這一點(diǎn))。這不僅給你一個(gè)可更容易開發(fā)和調(diào)試的程序,也更易于理解和維護(hù)。這正是它在金錢上的價(jià)值所在。這一點(diǎn)有賴某種人生經(jīng)驗(yàn)才能夠了解,因?yàn)楫?dāng)你努力讓某一段程序代碼變得比較優(yōu)雅時(shí),你并不是處于一種具生產(chǎn)力的狀態(tài)下。但是,請(qǐng)抗拒那些催促你趕工的人們,因?yàn)槟敲醋鲋粫?huì)減緩你的速度罷了。
2.
先求能動(dòng),再求快。即使你已確定某段程序代碼極為重要,而且是系統(tǒng)的重要瓶頸,這個(gè)準(zhǔn)則依然成立。盡可能簡化設(shè)計(jì),讓系統(tǒng)能夠先正確動(dòng)作。如果程序的執(zhí)行不夠快,再量測(cè)其效能。幾乎你總是會(huì)發(fā)現(xiàn),你所認(rèn)為的”瓶頸”其實(shí)都不是問題所在。把你的時(shí)間花在刀口上吧。3.
記住”各個(gè)擊破”的原理。如果你所探討的問題過于混雜,試著想像該問題的基本動(dòng)作會(huì)是什么,并假設(shè)這一小塊東西能夠神奇地處理掉最難的部分。這”一小塊”東西其實(shí)就是對(duì)象–請(qǐng)撰寫運(yùn)用該對(duì)象的程序代碼,然后檢視對(duì)象,并將其中困難的部分再包裝成其他對(duì)象,依此類推。
4. 區(qū)分class開發(fā)者和class使用者(使用端程序員)。Class
使用者扮演著”客戶”角色,不需要(也不知道)class的底層運(yùn)作方式。Class開發(fā)者必須是class設(shè)計(jì)專家,并撰寫class,使它能夠盡可能被大多數(shù)新手程序員所用,而且在程序中能夠穩(wěn)當(dāng)執(zhí)行。一套程序庫只有在具備通透性的情況下,使用起來才會(huì)容易。
5.當(dāng)你撰寫class時(shí),試著給予明了易懂的名稱,減少不必要的注解。你給客戶端程序員的接口,應(yīng)該保持概念上的單純性。不了這個(gè)目的,當(dāng)函數(shù)的重載(overloading)適合制作出直覺、易用的接口時(shí),請(qǐng)善加使用。
6. 也必你的分析和設(shè)計(jì)必須讓系統(tǒng)中的classes保持最少,須讓其Public
interfaces保持最少,以及讓這些classes和其他classes之間的關(guān)聯(lián)性( 尤其是base
classes)保持最少。如果你的設(shè)計(jì)所得結(jié)果更甚于此,請(qǐng)問問自己,是否其中每一樣?xùn)|西在整個(gè)程序生命期中都饒富價(jià)值?如果并非如此,那么,維護(hù)它們會(huì)使你付出代價(jià)。開發(fā)團(tuán)隊(duì)的成員都有不維護(hù)”無益于生產(chǎn)力提升”的任何東西的傾向;這是許多設(shè)計(jì)方法無法解釋的現(xiàn)象。
7.
讓所有東西盡量自動(dòng)化。先撰寫測(cè)試用的程序代碼(在你撰寫class之前),并讓它和class結(jié)合在一起。請(qǐng)使用makefile或類似工具,自動(dòng)進(jìn)行測(cè)試動(dòng)作。通過這種方式,只要執(zhí)行測(cè)試程序,所有的程序變動(dòng)就可以自動(dòng)獲得驗(yàn)證,而且可以立即發(fā)現(xiàn)錯(cuò)誤。由于你知道的測(cè)試架構(gòu)所具備的安全性,所以當(dāng)你發(fā)現(xiàn)新的需求時(shí),你會(huì)更勇于進(jìn)行全面修改。請(qǐng)記住,程序語言最大的改進(jìn),是來自型別檢查、異常處理等機(jī)制所賦予的內(nèi)置測(cè)試動(dòng)作。但這些功能只能協(xié)助你到達(dá)某種程度。開發(fā)一個(gè)穩(wěn)固系統(tǒng)時(shí),你得自己驗(yàn)證自己的classes或程序的性質(zhì)。
8. 在你撰寫class之前先寫測(cè)試碼,以便驗(yàn)證你的class 是否設(shè)計(jì)完備。如果你無法撰寫測(cè)試碼,你便無法知道你的class
的可能長相。撰寫測(cè)試碼通常能夠顯現(xiàn)出額外的特性(features)或限制 (
constraints)__它們并不一定總是能夠在分析和設(shè)計(jì)過程中出現(xiàn)。測(cè)試碼也可做為展示class 用法的示例程序。
9. 所有軟件設(shè)計(jì)上的問題,都可以通過”引入額外的概念性間接層(conceptual
indirection)”加以簡化。這個(gè)軟件工程上的基礎(chǔ)法則是抽象化概念的根據(jù),而抽象化概念正是面向?qū)ο蟪绦蛟O(shè)計(jì)的主要性質(zhì)。10.
間接層(indirection)應(yīng)該要有意義(和準(zhǔn)則-9致)。這里所指的意義可以像”將共用程序代碼置于惟一函數(shù)”這么簡單。如果你加入的間接層(或抽象化、或封裝等等)不具意義,它可能就和沒有適當(dāng)?shù)拈g接層一樣糟糕。
11.
讓class盡可能微小而無法切割(atomic)。賦予每個(gè)class單一而清楚的用途。如果你的classes或你的系統(tǒng)成長得過于復(fù)雜,請(qǐng)將復(fù)雜的classes切割成比較簡單的幾個(gè)classes。最明顯的一個(gè)判斷指針就是class的大小:如果它很大,那么它工作量過多的機(jī)會(huì)就可能很高,那就應(yīng)該被切割。重新設(shè)計(jì)class的建議線索是:
1) 復(fù)雜的switch語句:請(qǐng)考慮運(yùn)用多態(tài)(Polymorphism)。 2)
許多函數(shù)各自處理類型極為不同的動(dòng)作:請(qǐng)考慮切割為多個(gè)不同的(classes)。
12. 小心冗長的引數(shù)列(argument
lists)。冗長的引數(shù)列會(huì)使函數(shù)的調(diào)用動(dòng)作不易撰寫、閱讀、維護(hù)。你應(yīng)該試著將函數(shù)搬移到更適當(dāng)?shù)腸lass中,并盡量以對(duì)象為引數(shù)。
13. 不要一再重復(fù)。如果某段程序代碼不斷出現(xiàn)于許多derived class函數(shù)中,請(qǐng)將該段程序代碼置于某個(gè)base class
函數(shù)內(nèi),然后在derived
class函數(shù)中調(diào)用。這么做不僅可以省下程序代碼空間,也可以讓修改該段程序代碼動(dòng)作更易于進(jìn)行。有時(shí)候找出此種共通程序代碼還可以為接口增加實(shí)用功能。
14. 小心switch語句或成串的if-else 子句。通常這種情況代表所謂的”type-check
coding”。也就是說究竟會(huì)執(zhí)行哪一段程序代碼,乃是依據(jù)某種型別信息來做抉擇(最初,確切型別可能不十分明顯)。你通常可以使用繼承和多態(tài)來取代此類程序代碼;Polymorphical
method (多態(tài)函數(shù))的調(diào)用會(huì)自動(dòng)執(zhí)行此類型別檢驗(yàn),并提供更可靠更容易的擴(kuò)充性。
15. 從設(shè)計(jì)觀點(diǎn)來看,請(qǐng)找出變動(dòng)的事物,并使它和不變的事物分離。也就是說,找出系統(tǒng)中可能被你改變的元素,將它們封裝于classes中。
16. 不要利用subclassing來擴(kuò)充基礎(chǔ)功能。如果某個(gè)接口元素對(duì)class而言極重要,它應(yīng)該被放在base class
里頭,而不是直到衍生(derivation)時(shí)才被加入。如果你在繼承過程中加入了函數(shù),或許你應(yīng)該重新思考整個(gè)設(shè)計(jì)。
17. 少就是多。從class
的最小接口開始妨展,盡可能在解決問題的前提下讓它保持既小又單純。不要預(yù)先考量你的class被使用的所有可能方式。一旦class被實(shí)際運(yùn)用,你自然會(huì)知道你得如何擴(kuò)充接口。不過,一旦class被使用后,你就無法在不影響客戶程序代碼的情況下縮減其接口。如果你要加入更多函數(shù)倒是沒有問題–不會(huì)影響既有的客戶程序代碼,它們只需重新編譯即可。但即使新函數(shù)取代了舊函數(shù)的功能,也請(qǐng)你保留既有接口。如果你得通過”加入更多引數(shù)”的方式來擴(kuò)充既有函數(shù)的接口,請(qǐng)你以新引數(shù)寫出一個(gè)重載化的函數(shù);通過
這種方式就不會(huì)影響既有函數(shù)的任何客戶了。
18. 大聲念出你的classes,確認(rèn)它們符合邏輯。請(qǐng)base class和derived class
之間的關(guān)系是”is-a”(是一種),讓class和成員對(duì)象之間的關(guān)系是”has-a”(有一個(gè))。
19.
當(dāng)你猶豫不決于繼承(inheritance)或合成(組合,composition)時(shí),請(qǐng)你問問自己,是否需要向上轉(zhuǎn)型(upcast)為基礎(chǔ)型別。如果不需要,請(qǐng)優(yōu)先選擇合成(也就是是使用成員對(duì)象)。這種作法可以消除”過多基礎(chǔ)型別”。如果你采用繼承,使用者會(huì)認(rèn)為他們應(yīng)該可以向上轉(zhuǎn)型。
20. 運(yùn)用數(shù)據(jù)成員來表示數(shù)值的變化,運(yùn)用經(jīng)過覆寫的函數(shù)(overrided method)來代表行為的變化 。也就是說,如果你找到了某個(gè)
class, 帶有一些狀態(tài)變量,而其函數(shù)會(huì)依據(jù)這些變量值切換不同的行為,那么你或許就應(yīng)該重新設(shè)計(jì),在subclasses 和覆寫后的函數(shù)(overrided
methods)中展現(xiàn)行為止的差異。
21.
小心重載(overloading)。函數(shù)不應(yīng)該依據(jù)引數(shù)值條件式地選擇執(zhí)行某一段程序代碼。這種情況下你應(yīng)該撰寫兩個(gè)或更多個(gè)重載函數(shù)(overloaded
methods)22. 使用異常體系(exception hierarchies)最好是從Java標(biāo)準(zhǔn)異常體系中衍生特定的classes,
那么,捕捉異常的人便可以捕捉特定異常,之后才捕捉基本異常。如果你加入新的衍生異常,原有的客戶端程序仍能通過其基礎(chǔ)型別來捕捉它。
23.
有時(shí)候簡單的聚合(aggregation)就夠了。飛機(jī)上的”旅客舒適系統(tǒng)”包括數(shù)個(gè)分離的元素:座椅、空調(diào)、視訊設(shè)備等等,你會(huì)需要在飛機(jī)上產(chǎn)生許多這樣的東西。你會(huì)將它們聲明為Private成員并開發(fā)出一個(gè)全新的接口嗎?不會(huì)的,在這個(gè)例子中,元素也是Public接口的一部分,所以仍然是安全的。當(dāng)然啦,簡單聚合并不是一個(gè)常被運(yùn)用的解法,但有時(shí)候的確是。
24. 試著從客戶程序員和程序維護(hù)的角度思考。你的class應(yīng)該設(shè)計(jì)得盡可能容易使用。你應(yīng)該預(yù)先考量可能性有的變動(dòng),并針對(duì)這些
可能的變動(dòng)進(jìn)行設(shè)計(jì),使這些變動(dòng)日后可輕易完成。
25.
小心”巨大對(duì)象并發(fā)癥”。這往往是剛踏OOP領(lǐng)域的過程式(procedural)程序員的一個(gè)苦惱,因?yàn)樗麄兺罱K還是寫出一個(gè)過程式程序,并將它們擺放到一個(gè)或兩個(gè)巨大對(duì)象中。注意,除了application
framework (應(yīng)用程序框架,譯注:一種很特殊的、大型OO程序庫,幫你架構(gòu)程序本體)之外,對(duì)象代表的是程序中的觀念,而不是程序本身。
26. 如果你得用某種丑陋的方式來達(dá)成某個(gè)動(dòng)作,請(qǐng)將丑陋的部分局限在某個(gè)class里頭。
27.
如果你得用某種不可移植方式來達(dá)成某個(gè)動(dòng)作,請(qǐng)將它抽象化并局限于某個(gè)class里頭。這樣一個(gè)”額外間接層”能夠防止不可移植的部分?jǐn)U散到整個(gè)程序。這種作法的具體呈現(xiàn)便是Bridge設(shè)計(jì)模式(design
pattern)。28.
對(duì)象不應(yīng)僅僅只用來持有數(shù)據(jù)。對(duì)象也應(yīng)該具有定義明確界限清楚的行為。有時(shí)候使用”數(shù)據(jù)對(duì)象”是適當(dāng)?shù)模挥性谕ㄓ眯稳萜鞑贿m用時(shí),才適合刻意以數(shù)據(jù)對(duì)象來包裝、傳輸一群數(shù)據(jù)項(xiàng)。
29.
欲從既有的classes身上產(chǎn)生新的classes時(shí),請(qǐng)以組合(composition)為優(yōu)先考量。你應(yīng)該只在必要時(shí)才使用繼承。如果在組合適用之處你卻選擇了繼承,你的設(shè)計(jì)就滲雜了非必要的復(fù)雜性。
30.
運(yùn)用繼承和函數(shù)覆寫機(jī)制來展現(xiàn)行為上的差異,運(yùn)用fields(數(shù)據(jù)成員)來展現(xiàn)狀態(tài)上的差異。這句話的極端例子,就是繼承出不同的classes表現(xiàn)各種不同的顏色,而不使用”color”field.31.
當(dāng)心變異性(variance)。語意相異的兩個(gè)對(duì)象擁有相同的動(dòng)作(或說責(zé)任)是可能的。OO世界中存在著一種天生的引誘,讓人想要從某個(gè)class繼承出另一個(gè)subclass,為的是獲得繼承帶來的福利。這便是所謂”變異性”。但是,沒有任何正當(dāng)理由足以讓我們強(qiáng)迫制造出某個(gè)其實(shí)并不存在的superclass/subclass關(guān)系。比較好的解決方式是寫出一個(gè)共用的base
class,它為兩個(gè)derived
classes制作出共用接口–這種方式會(huì)耗用更多空間,但你可以如你所盼望地從繼承機(jī)制獲得好處,而且或許能夠在設(shè)計(jì)上獲得重大發(fā)現(xiàn)。
32.
注意繼承上的限制。最清晰易懂的設(shè)計(jì)是將功能加到繼承得來的class里頭;繼承過程中拿掉舊功能(而非增加新功能)則是一種可疑的設(shè)計(jì)。不過,規(guī)則可以打破。如果你所處理的是舊有的class程序庫,那么在某個(gè)class的subclass限制功能,可能會(huì)比重新制定整個(gè)結(jié)構(gòu)(俾使新class得以良好地相稱于舊
class)有效率得多。
33. 使用設(shè)計(jì)模式(design patterns)來減少”赤裸裸無加掩飾的機(jī)能(naked
functionality)”。舉個(gè)例子,如果你的class只應(yīng)該產(chǎn)出惟一一個(gè)對(duì)象,那么請(qǐng)不要以加思索毫無設(shè)計(jì)的手法來完成它,然后撰寫”只該產(chǎn)生一份對(duì)象”這樣的注解就拍拍屁股走人。請(qǐng)將它包裝成singleton(譯注:一個(gè)有名的設(shè)計(jì)模式,可譯為”單件”)。如果主程序中有多而混亂的”用以產(chǎn)生對(duì)象”的程序代碼,請(qǐng)找出類似
factory method這樣的生成模式(creational patterns),使價(jià)錢可用以封裝生成動(dòng)作減少”赤裸裸無加掩飾的機(jī)能”(naked
functionality)不僅可以讓你的程序更易理解和維護(hù),也可以阻止出于好意卻帶來意外的維護(hù)者。
34. 當(dāng)心”因分析而導(dǎo)致的癱瘓(analysis
paralysis)”。請(qǐng)記住,你往往必須在獲得所有信息之前讓項(xiàng)目繼續(xù)前進(jìn)。而且理解未知部分的最好也最快的方式,通常就是實(shí)際前進(jìn)一步而不只是紙上談兵。除非找到解決辦法,否則無法知道解決辦法。Java擁有內(nèi)置的防火墻,請(qǐng)讓它們發(fā)揮作用。你在單一class或一組classes中所犯的錯(cuò)誤,并不會(huì)傷害整個(gè)系統(tǒng)的完整性。
35.
當(dāng)你認(rèn)為你已經(jīng)獲得一份優(yōu)秀的分析、設(shè)計(jì)或?qū)崿F(xiàn)時(shí),請(qǐng)?jiān)囍右匝菥殹F(tuán)隊(duì)以外的某些人帶進(jìn)來-他不必非得是個(gè)顧問不可,他可以是公司其他團(tuán)隊(duì)的成員。請(qǐng)那個(gè)人以新鮮的姿態(tài)審視你們的成果,這樣可以在尚可輕易修改的階段找出問題,其收獲會(huì)比因演練而付出的時(shí)間和金錢代價(jià)來得高。實(shí)現(xiàn)
(Implementation)
36. 一般來說,請(qǐng)遵守Sun的程序編寫習(xí)慣。
37.
無論使用何種編寫風(fēng)格,如果你的團(tuán)隊(duì)(或整個(gè)公司,那就更好了)能夠加以標(biāo)準(zhǔn)化,那么的確會(huì)帶來顯著效果。這代表每個(gè)人都可以在其他人不遵守編寫風(fēng)格修改其作品,這是個(gè)公平的游戲。標(biāo)準(zhǔn)化的價(jià)值在于,分析程序代碼時(shí)所花的腦力較小,因而可以專心于程序代碼的實(shí)質(zhì)意義。
38. 遵守標(biāo)準(zhǔn)的大小寫規(guī)范。將
class名稱的第一個(gè)字母應(yīng)為大寫。數(shù)據(jù)成員、函數(shù)、對(duì)象(references)的第一個(gè)字母應(yīng)為小寫。所有識(shí)別名稱的每個(gè)字都應(yīng)該連在一塊兒,所有非首字的第一個(gè)字母都應(yīng)該大寫。例如:
ThisIsAClassName thisIsAMethodOrFieldName 如果你在static final
基本型別的定義處指定了常量初始式(constant initializers),那么該識(shí)別名稱應(yīng)該全為大寫,代表一個(gè)編譯期常量。
Packages是個(gè)特例,其名稱皆為小寫,即使非首字的字母亦是如此。域名(org, net, edu 等等)皆應(yīng)為小寫。(這是Java 1.1遷移至Java
2時(shí)的一項(xiàng)改變) 。
39、不要自己發(fā)明”裝飾用的”Private數(shù)據(jù)成員名稱。通常這種的形式是在最前端加上底線和其他字符,匈牙利命名法(Hungarian
notation)是其中最差的示范。在這種命名法中,你得加入額外字符來表示數(shù)據(jù)的型別、用途、位置等等。仿佛你用的是匯編語言(assembly
language)而編譯器沒有提供任何協(xié)肋似的。這樣的命名方式容易讓人混淆又難以閱讀,也不易推行和維護(hù)。就讓classes和packages來進(jìn)行”名稱上的范圍制定(name
scoping)”吧。
40、當(dāng)你擬定通用性的class時(shí),請(qǐng)遵守正規(guī)形式(canonical form)。包括equals( )、hashCode( )、clone( )
( 實(shí)現(xiàn)出Cloneable),并實(shí)現(xiàn)出Comparable和Serialiable等等。
41、對(duì)于那些”取得或改變Private數(shù)據(jù)值”的函數(shù),請(qǐng)使用Java Beans
的”get”、”set”、”is”等命名習(xí)慣,即使你當(dāng)時(shí)不認(rèn)為自己正在撰寫Java
Bean。這么做不僅可以輕易以Bean的運(yùn)用方式來運(yùn)用你的class,也是對(duì)此類函數(shù)的一種標(biāo)準(zhǔn)命名方式,使讀者更易于理解。
42、對(duì)于你所擬定的每一個(gè)class,請(qǐng)考慮為它加入static public test(
),其中含有class功能測(cè)試碼。你不需要移除該測(cè)試就可將程序納入項(xiàng)目。而且如果有所變動(dòng),你可以輕易重新執(zhí)行測(cè)試。這段程序代碼也可以做為class的使用示例。
43、有時(shí)候你需要通過繼承,才得以訪問base class的protected成員。這可能會(huì)引發(fā)對(duì)多重基類(multiple base
types)的認(rèn)識(shí)需求。如果你不需要向上轉(zhuǎn)型,你可以先衍生新的class發(fā)便執(zhí)行protected訪問動(dòng)作,然后在”需要用到上述
protected成員”的所有classes中,將新class聲明為成員對(duì)象,而非直接繼承。
44、避免純粹為了效率考量而使用final函數(shù)。只有在程序能動(dòng)但執(zhí)行不夠快時(shí),而且效能量測(cè)工具(profiler)顯示某個(gè)函數(shù)的調(diào)用動(dòng)作成為瓶頸時(shí),才使用final函數(shù)。
45、如果兩個(gè)classes因某種功能性原因而產(chǎn)生了關(guān)聯(lián)(例如容器containers和迭代器iterators),那么請(qǐng)?jiān)囍屍渲心硞€(gè)class成為另一個(gè)class
的內(nèi)隱類(inner class)。這不僅強(qiáng)調(diào)二者間的關(guān)聯(lián),也是通過”將class名稱嵌套置于另一個(gè)class 內(nèi)”而使同一個(gè)class
名稱在單一Package中可被重復(fù)使用。Java 容器庫在每個(gè)容器類中都定義了一個(gè)內(nèi)隱的(inner)Iterator
class,因而能夠提供容器一份共通接口。運(yùn)用內(nèi)隱類的另一個(gè)原因是讓它成為private實(shí)現(xiàn)物的一部分。在這里,內(nèi)隱類會(huì)為信息隱藏帶來好處,而不是對(duì)上述的class關(guān)聯(lián)性提供肋益,也不是為了防止命名空間污染問題(namespace
pollution)。
46、任何時(shí)候你都要注意那些高度耦合(coupling)的 classes.請(qǐng)考慮內(nèi)隱類(inner
classes)為程序擬定和維護(hù)帶來的好處。內(nèi)隱類的使用并不是要去除classes間的耦合,而是要讓耦合關(guān)系更明顯也更便利。
47、不要成為”過早最佳化”的犧牲品。那會(huì)讓人神經(jīng)錯(cuò)亂。尤其在系統(tǒng)建構(gòu)初期,先別煩惱究竟要不要撰寫(或避免)原生函數(shù)(native
methods)、要不要將某些數(shù)聲明為final、要不要調(diào)校程序代碼效率等等。你的主要問題應(yīng)該是先證明設(shè)計(jì)的正確性,除非設(shè)計(jì)本身需要某種程度的效率。
對(duì)于程序員來說,養(yǎng)成良好的代碼寫作能力是非常重要的。
今天,我們就一起來了解一下,規(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ì)去掉開發(fā)時(shí)寫的注釋,除去所有空格和換行,甚至可以把原來較長的變量名替換成短且無意義的變量名,這樣做的目的是加快文件的下載速度,同時(shí)也減小網(wǎng)站訪問帶來的額外數(shù)據(jù)流量,另外在代碼保護(hù)上也起到了一點(diǎn)點(diǎn)作用,至少壓縮后的代碼即使被還原還是沒那么容易一下讀懂的。
要想代碼能正確通過壓縮,一般要求語句都要以分號(hào)正常結(jié)束,大括號(hào)也要嚴(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),比如左大括號(hào){是否另起一行。
達(dá)到這個(gè)要求的目的在于方便你的開發(fā)團(tuán)隊(duì)成員拿你代碼的一個(gè)副本用IDE自動(dòng)格式化成他喜歡或熟悉的風(fēng)格進(jìn)行閱讀。
你同事需要閱讀你的代碼,可能是因?yàn)槟銓懙氖峭ㄓ梅椒ǎ谄渌K開發(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è)開放平臺(tái),就像facebook點(diǎn)抗 應(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)升級(jí)或新增功能,修改起代碼來也輕松多了。
如果到頭發(fā)現(xiàn)自己當(dāng)初寫的代碼現(xiàn)在看不太懂了,那還真是天大的笑話了。
Java代碼之于java程序員而言就是左膀右臂,java代碼寫的好的java程序員明顯更是企業(yè)的歡迎,一個(gè)優(yōu)秀的java程序員的考核標(biāo)準(zhǔn)之一也是看他的編程水平。
其實(shí)有的java程序員java代碼會(huì)受到大家的追捧,是因?yàn)樗趯懘a時(shí)注意的細(xì)節(jié)往往多于那些不怎么關(guān)注java代碼編程細(xì)節(jié)的程序員,俗話說:“細(xì)節(jié)決定成敗”,那么如何寫出好的java代碼呢?IT培訓(xùn)介紹一起來討論下:
1.重視注釋
有的java程序員在寫代碼時(shí),從來沒有想過要在java代碼后加上相關(guān)的注釋,甚至是上萬行的代碼也沒有想過加上注釋,這就存在很大的問題,不說你的代碼會(huì)跟其他人分享討論,就你自己回顧你是怎么寫好這篇代碼的,你也是半天無法理出頭緒,這就為維護(hù)和修改等等工作添加了很大的麻煩。所以,要想寫出好的java代碼,一定從簡短的java代碼編寫開始注重在java代碼后面加上相應(yīng)的注釋,養(yǎng)成良好的習(xí)慣。
2.重視排版整潔
看很多java程序員的排版總覺得在欣賞一幅藝術(shù)品,但是看到一些java程序員的排版卻總覺得無力吐槽。同樣是編寫代碼,但是給人的視覺體驗(yàn)是相當(dāng)?shù)牟煌?dāng)然好的java代碼給人的享受也是美的,所以要想寫出好的代碼,一定要重視排版整潔。
3.注重命名規(guī)則
現(xiàn)在在一個(gè)團(tuán)隊(duì)開發(fā)中,都會(huì)提前定制一個(gè)統(tǒng)一的命名規(guī)則,這樣利于提高工作效益。但是很多java程序員是缺乏這個(gè)意識(shí)的,每次敲代碼,更喜歡按照自己慣常的方式老命名模塊、函數(shù),這樣是方便了自己,但是忽視團(tuán)隊(duì)協(xié)作,所以在日常工作中,特別是團(tuán)隊(duì)工作中一定要重視命名規(guī)則。
4.養(yǎng)成備份習(xí)慣
備份的重要性不用小編強(qiáng)調(diào),相必你也知道。但是有的java程序員就是沒有養(yǎng)成這樣的好習(xí)慣,每次敲完代碼就不記得隨手保存,每次等到除了事故,比如電腦出了故障,辛辛苦苦敲打的java代碼沒保存找不回來的情況下就開始懊惱,與其這樣還不如在一開始就養(yǎng)成良好的備份習(xí)慣,這樣也方便自己日后查找利用。
新聞名稱:java如何讓代碼整潔 java如何調(diào)整代碼格式
當(dāng)前路徑:http://chinadenli.net/article46/ddgspeg.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站導(dǎo)航、網(wǎng)站制作、網(wǎng)站營銷、手機(jī)網(wǎng)站建設(shè)、微信小程序、域名注冊(cè)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場,如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)