Java編程規範(一)

最近在看一本有關Java編程規範的書,書中精煉闡述了使用java語言時應該遵循的一些原則。接下來的一段時間我將在這裏總結個人學習內容,也但願這一系列文章可以對有須要的人有所幫助。java

不考慮任何編碼規範的代碼每每存在不少Bug,嚴重狀況下還會制約軟件開發的進度。良好的編程規範不只能使團隊裏的每一個人都能輕鬆的閱讀並理解其餘人的代碼、減小Bug的產生,並且讓後期的維護工做更加行之有效,從而使代碼更具準確性、健壯性、可維護性與可擴展性。因此擁有良好一致的編程規範對於一個團隊相當重要。編程

1、通常原則

(一)保持原有風格

在修改原有的軟件時,應該保持原有代碼的編寫風格。學習

咱們不該該在原有的代碼中引入新的風格,在同一段代碼中使用不一樣的編程風格會讓咱們的代碼難以理解。同時咱們也不該該重寫舊的軟件去迎合新的風格,這樣極可能會使原來的程序產生嚴重的功能缺陷。編碼

(二)堅持最小驚奇原則

在編碼過程當中儘可能避免可能讓軟件用戶感到意外的作法。代碼規範

用戶在使用軟件中產生的任何交互行爲必須都是可預見的,除非在說明文檔中明確記錄下全部的很是規行爲而且說明這樣作的理由。爲了達到這一目的,在Java軟件的開發過程當中應該遵循如下幾點:對象

  • 簡單性:構建簡單的類和方法。接口

  • 清晰性:明確每一個變量、類、接口、方法、對象的用途。開發

  • 完整性:提供用戶所指望的完整的程序功能,而且爲此編寫完整的說明文檔。文檔

  • 一致性:類似的實體,其外觀和行爲也要大體相同;反之亦然。原型

  • 健壯性:對錯誤和異常作出預測,而且在說明文檔中提供相應的解決辦法。

(三)第一次就作對

將以上的這些規則應用到咱們編寫的任何代碼中,而不僅是產品自己的代碼。

一般狀況下,那些原型代碼最終都會被寫入成品軟件中。因爲咱們一開始就已經遵循了編碼規範,因此咱們不須要爲特定的產品修改代碼規範。那些閱讀咱們代碼的人也會從中受益不淺。

(四)記錄全部非規範行爲

沒有什麼標準是完美且可以放之四海而皆準的,有時候你會發現本身不得不偏離已經創建好的標準體系。

標準並非適用於任何地方,在打破一條規則以前,咱們須要確保咱們已經對這條準則有了深刻的理解並且清楚打破規則後的後果。此外,咱們應該在文檔中記錄下這樣作的理由。

以上就是通常原則的內容,沒有涉及具體的代碼,可是咱們在進行下面的學習或者編碼以前應該對以上的內容有所理解。

相關文章
相關標籤/搜索