原創|行業資訊|編輯:龔雪|2014-03-27 09:38:45.000|閱讀 338 次
概述:代碼質量至關重要,小編收集了十大提高代碼質量的技巧。
# 界面/圖表報表/文檔/IDE等千款熱門軟控件火熱銷售中 >>
軟件開發中,高質量的代碼往往是縮短開發周期的重要因素。特別是在出軟件測試中,尤為重要。
小編收集了高級軟件工程師和網絡達人在代碼編寫時用過的各種小技巧。
1. 盡量保持方法簡短
盡管很多人都遵循這個規則,但它仍然非常的重要。你寫的方法要始終能在一個屏幕里放得下。如果你需要去滾動屏幕,這會分散你的注意力,而且你看不到整 個的上下文。最佳長度是5-20行,這根據你的情況而定。當然,getters/setters 通常是一行代碼的方法,但與其說它們是真正的方法,不如說它們只是存取工具。
2. 永遠永遠不要把同一個變量用于多個不同的目的
一個變量應該始終只為一個目的服務。通過使變量常量化(C++里的const, JAVA里的final),使得編譯器能夠優化編譯,而且使你的代碼醒目表達這個變量是不能改變的,你的程序的可讀性會變得更好。
3. 使用自描述的變量名和方法名
你的代碼應該,對于任何人來說,只要看一眼就能知道是干嘛的。盡量不要用簡寫方式,除非有特殊的習慣,就像下面的:
src - source
pos - position
prev - previous
如果你認為描述性的名稱并不是那么有價值,請對比一下n, ns, nsisd 和 numTeamMembers, seatCount, numSeatsInStadium。
4. 盡可能的把變量定義在靠近使用它的地方
蓋房子時,你可不希望把錘子放到別人的院子里。你希望把它們放的離手頭越近越好。定義變量也是同樣的道理。
int foo = 3;
int bar = 5;
// 一大段使用“bar”的代碼,
// 但沒用到“foo”
// ...
baz(foo);
這段代碼可以簡單的重構成
int bar = 5;
// 一大段使用“bar”的代碼,
// 但沒用到“foo”
// ...
int foo = 3;
baz(foo);
當你把變量的聲明和第一次用到它的地方間隔太遠時(距離超過一個屏幕),這確實會成為一個問題。記住上下文關系會變得困難,你需要滾動屏幕去找哪來的這個變量。
5. 拒絕神秘數字
當你要把什么東西跟一個常量值做比較時,記得把這個值定義成常量。沒有什么會比去猜測你的同事寫的這樣的代碼更讓人頭疼的事了:
il < 4384
換個形式感覺如何?
inputLength < MAX_INPUT_LENGTH
6. 友好的對待你的語言
學習新語言是一種很有樂趣的事情,你能學到一種新的完成任務的途徑。當一個對一種語言已經很專業的人去學習另一種語言時,會出現一種很大的負面效應。比如說你是一個Java開發者,試圖去學習Ruby。你應該學會用Ruby的方式解決問題,而不是沿用Java的解決問題的思想。
當你需要重復5遍”Hello world!“時,在Java里,你可能會這樣做:
for (int i = 0; i < 5; i++) {
System.out.println("Hello world!");
}
在Ruby里,你也許會禁不住這樣寫:
for i in (0..5)
puts "Hello world!"
end
這樣看起來沒問題,但有一個更好的方式:
5.times { puts "Hello world!" }
7. 不要逆常規而行
8. 警惕過早優化
過早優化是所有問題的根源,至少電視上是這么說的 … 你第一應該關心的事情是寫出易于理解的代碼。起初寫的程序不要求快。除非你的程序很慢,否則談優化都是為時太早。如果你想優化什么東西,你首先需要知道問 題出在哪。這就是我們需要profilers這個工具的原因。
在沒有知道問題在哪的情況下試圖對程序進行優化,其結果必然是把程序能壞,至少你的代碼會喪失可讀性。如果你覺得有些地方很慢,不要盲目的重寫代碼,你應先找到慢的證據。
不要傻乎乎的去解決根本不存在的問題。
9. 積極重構測試過的程序
沒有任何東西會是完美的。即使你感覺你真正寫出了一段完美的代碼,幾個月后回頭再看看,你可能會驚訝道”怎么會這樣傻?“
改進程序的一個好方法就是重構,但要等程序測試通過之后。你首先要確保程序是好的可運行的,你可以通過自動化測試或手工測試完成這個工作。
之初,你需要的是程序可用。不要期望在第一次就寫出完美的程序,你只需要把它寫出來,可用。然后重構它,使之完美。對于你們當中知道測試驅動開發 (TDD)的人來說,對這個會很熟悉。這里的關鍵就在于你要習慣于重構這種事情。如果你使用的是像IntelliJ IDEA這樣強大的集成開發工具的話,重構的工作會變得簡單的多。
10. 不要過度沉迷于技巧
當我第一次讀到有關設計模式的知識時,我覺得我找到了圣杯。這些精心設計的思想作用顯著,它能使你的設計易于理解,因為你可以簡單的說”我使用的是 ‘觀察器模式’“,而不用從頭到尾的解釋一遍。那么,有問題嗎?一切看起來都這么自然、簡單,你開始不論在哪都使用設計模式。為什么不把這個類做成 singleton呢?干嘛不去再創建一些工廠類呢?
于是一個80行就能寫完的腳本,你最終使用了10個類,15個接口,外加一大堆范式和標記符。97%的代碼不做任何事情。設計模式是一種十分有用的用來簡化你的設計的工具,但這不意味著你該在所有能用到的地方都用它。你應該用它們,但不能濫用。
專業的代碼質量提升工具ReSharper下載(PS:近期打折優惠中)
本站文章除注明轉載外,均為本站原創或翻譯。歡迎任何形式的轉載,但請務必注明出處、不得修改原文相關鏈接,如果存在內容上的異議請郵件反饋至chenjj@fc6vip.cn
文章轉載自:慧都控件網