Java編程規范(一)

最近在看一本有關Java編程規范的書,書中精煉闡述了使用java語言時應該遵循的一些原則。接下來的一段時間我將在這里總結我的學習內容,也希望這一系列文章能夠對有需要的人有所幫助。
不考慮任何編碼規范的代碼往往存在很多Bug,嚴重情況下還會制約軟件開發的進度。良好的編程規范不僅能使團隊里的每個人都能輕松的閱讀并理解其他人的代碼、減少Bug的產生,而且讓后期的維護工作更加行之有效,從而使代碼更具準確性、健壯性、可維護性與可擴展性。所以擁有良好一致的編程規范對于一個團隊至關重要。

一、一般原則

(一)保持原有風格

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

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

(二)堅持最小驚奇原則

在編碼過程中盡量避免可能讓軟件用戶感到意外的做法。

用戶在使用軟件中產生的任何交互行為必須都是可預見的,除非在說明文檔中明確記錄下所有的非常規行為并且說明這樣做的理由。為了達到這一目的,在Java軟件的開發過程中應該遵循以下幾點:

  • 簡單性:構建簡單的類和方法。
  • 清晰性:明確每個變量、類、接口、方法、對象的用途。
  • 完整性:提供用戶所期望的完整的程序功能,并且為此編寫完整的說明文檔。
  • 一致性:相似的實體,其外觀和行為也要大致相同;反之亦然。
  • 健壯性:對錯誤和異常做出預測,并且在說明文檔中提供相應的解決辦法。
(三)第一次就做對

將以上的這些規則應用到我們編寫的任何代碼中,而不只是產品本身的代碼。

通常情況下,那些原型代碼最終都會被寫入成品軟件中。由于我們一開始就已經遵循了編碼規范,所以我們不需要為特定的產品修改代碼規范。那些閱讀我們代碼的人也會從中受益匪淺。

(四)記錄所有非規范行為

沒有什么標準是完美且能夠放之四海而皆準的,有時候你會發現自己不得不偏離已經建立好的標準體系。

標準并不是適用于任何地方,在打破一條規則之前,我們需要確保我們已經對這條準則有了深入的理解而且清楚打破規則后的后果。此外,我們應該在文檔中記錄下這樣做的理由。

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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,885評論 6 541
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,312評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 177,993評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,667評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,410評論 6 411
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,778評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,775評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,955評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,521評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,266評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,468評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,998評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,696評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,095評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,385評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,193評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,431評論 2 378

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,714評論 25 708
  • 本文把程序員所需掌握的關鍵知識總結為三大類19個關鍵概念,然后給出了掌握每個關鍵概念所需的入門書籍,必讀書籍,以及...
    dle_oxio閱讀 11,167評論 6 244
  • 俗話講:光說不練假把式。練習口語的方法我們已經講了很多,但如果總停留在方法地學習上,就是再學一百年,你的口語還是...
    海波家的自留地閱讀 534評論 2 4
  • 你孤獨時,有個人跟你作伴。 你害怕時,有個人給你壯膽。 你壓力山大時,有個人和你一起承擔。 你惶然無助時,有個人為...
    北默蕭丶閱讀 164評論 0 0