最近在看一本有關Java編程規范的書,書中精煉闡述了使用java語言時應該遵循的一些原則。接下來的一段時間我將在這里總結我的學習內容,也希望這一系列文章能夠對有需要的人有所幫助。
不考慮任何編碼規范的代碼往往存在很多Bug,嚴重情況下還會制約軟件開發的進度。良好的編程規范不僅能使團隊里的每個人都能輕松的閱讀并理解其他人的代碼、減少Bug的產生,而且讓后期的維護工作更加行之有效,從而使代碼更具準確性、健壯性、可維護性與可擴展性。所以擁有良好一致的編程規范對于一個團隊至關重要。
一、一般原則
(一)保持原有風格
在修改原有的軟件時,應該保持原有代碼的編寫風格。
我們不應該在原有的代碼中引入新的風格,在同一段代碼中使用不同的編程風格會讓我們的代碼難以理解。同時我們也不應該重寫舊的軟件去迎合新的風格,這樣很可能會使原來的程序產生嚴重的功能缺陷。
(二)堅持最小驚奇原則
在編碼過程中盡量避免可能讓軟件用戶感到意外的做法。
用戶在使用軟件中產生的任何交互行為必須都是可預見的,除非在說明文檔中明確記錄下所有的非常規行為并且說明這樣做的理由。為了達到這一目的,在Java軟件的開發過程中應該遵循以下幾點:
- 簡單性:構建簡單的類和方法。
- 清晰性:明確每個變量、類、接口、方法、對象的用途。
- 完整性:提供用戶所期望的完整的程序功能,并且為此編寫完整的說明文檔。
- 一致性:相似的實體,其外觀和行為也要大致相同;反之亦然。
- 健壯性:對錯誤和異常做出預測,并且在說明文檔中提供相應的解決辦法。
(三)第一次就做對
將以上的這些規則應用到我們編寫的任何代碼中,而不只是產品本身的代碼。
通常情況下,那些原型代碼最終都會被寫入成品軟件中。由于我們一開始就已經遵循了編碼規范,所以我們不需要為特定的產品修改代碼規范。那些閱讀我們代碼的人也會從中受益匪淺。
(四)記錄所有非規范行為
沒有什么標準是完美且能夠放之四海而皆準的,有時候你會發現自己不得不偏離已經建立好的標準體系。
標準并不是適用于任何地方,在打破一條規則之前,我們需要確保我們已經對這條準則有了深入的理解而且清楚打破規則后的后果。此外,我們應該在文檔中記錄下這樣做的理由。
以上就是一般原則的內容,沒有涉及具體的代碼,但是我們在進行下面的學習或者編碼之前應該對以上的內容有所理解。