Posted on 2011-04-26 21:20
RTY 閱讀(310)
評論(0) 編輯 收藏 引用 所屬分類:
編程常識
我們中的大多數(shù)人都經(jīng)歷過費解代碼的糾纏。我們中的許多人自己就編寫過費解的代碼。寫出自己能理解的代碼很容易,因為在寫這些代碼時,我們正深入于要解決的問題中。代碼的其他維護者不會那么深入,也就不易理解代碼。
軟件項目的主要成本在于長期維護。為了在修改時盡量降低出現(xiàn)缺陷的可能性,很有必要理解系統(tǒng)是做什么的。當系統(tǒng)變得越來越復(fù)雜,開發(fā)者就需要越來越多的時間來理解它,而且業(yè)績有可能誤解。所以,代碼應(yīng)當清晰地表達其作者的意圖。作者把代碼寫得越清晰,其他人花在理解代碼上的時間也就越少,從而減少缺陷,縮減維護成本。
可以通過選用好名稱來表達。我們想要聽到好類名和好函數(shù)名,而且在查看其權(quán)則時不會大吃一驚。
也可以通過保持函數(shù)和類尺寸短小來表達。短小的類和函數(shù)通常易于命名,易于編寫,易于理解。
還可以通過采用標準命名法來表達。例如,設(shè)計模式很多大程度上就關(guān)乎溝通和表達。通過在實現(xiàn)這些模式的類的名稱中采用標準模式名,例如COMMAND或VISITOR,就能充分地向其他開發(fā)者描述你的設(shè)計。
編寫良好的單元測試也具有表達性。測試的主要目的之一就是通過實例起到文檔的作用。讀到測試的人應(yīng)該能很快理解某個類是做什么的。
不過,做到表達力的最重要方式卻是嘗試。有太多時候,我們寫出能工作的代碼,就轉(zhuǎn)移到下一個問題上,沒有下足功夫調(diào)整代碼,讓后來者易于閱讀。技戰(zhàn)術(shù),下一位讀代碼的人最有可能是你自己。
所以,多少尊重一下你的手藝吧。花一點點時間在每個函數(shù)和類上。選用較好的名稱,將大函數(shù)切分為小函數(shù),時時關(guān)注自己創(chuàng)建的東東,用心是最珍貴的資源。