程式設計師這樣寫程式碼

await發表於2013-01-28

  去年二月初有幸成為一個優秀產品組裡的一員,一年的工作中遇到各種問題,但是讓我受益良多的還是關於如何編寫優良的程式碼。說明如何寫程式碼的文章很多,這裡列出一些我在工作中遇到的情形,如有不當之處還請及時指正。

  1. 讓命名變得有意義。

  在你的程式碼中使用有意義的名稱去命名你的變數和方法等。我們應該通過名稱就可以知道該變數或者方法的大致用途,優雅的程式碼應該是自解釋的。一個好的名稱要比一個泛泛的命名加上一堆註釋行之有效。

  2. 編寫簡潔可讀性強的程式碼。

  程式碼不僅僅是為了讓程式能夠執行起來,程式碼還得供人閱讀和修改,因此程式碼的簡潔性和可讀性對於程式碼的維護甚為重要。用盡量少的程式碼做盡量多的事,這樣可以降低出錯的機率,也可以使程式碼更加優雅和簡潔。一個方法只負責一件事,不要將多件事的不同邏輯放在一個方法內。讓你的方法的行數控制在一屏之內,這樣方便閱讀。簡潔優雅的程式碼需要我們不斷的努力和嘗試,直到可以隨心所欲寫出優雅的程式碼。

  3. 為你的程式碼新增註釋。

  “靠!為什麼這裡要乘以0.75?”你在看程式碼的時候是不是會經常發生這種事?有沒有過自己寫的程式碼過了一段時間看不懂了?所以在你程式碼必要的地方加上註釋!為了你和將來維護你程式碼的人,在必要的地方寫上你為什麼這麼做、為什麼要引入這個變數,從而讓你的程式碼具有更佳的可讀性和管理性。

  4. 不要複製現有的程式碼。

  在當前程式中複製、貼上現有程式碼會導致一個程式碼片段在應用程式中多處出現。將來如果需要改變這些程式碼時,一旦忘記修改所有的,就會產生bug了。而且複製、貼上現有的程式碼也會讓檔案變得混亂和臃腫,不利於檔案的管理。

  5. 只捕獲你能處理的異常。

  當我們在程式碼中使用try{...}catch(...Exception){...}捕獲異常時,這就表明我們察覺到程式碼中包含著可能失敗出錯的程式碼,並且我們知道怎麼處理該異常並恢復錯誤的邏輯。如果我們捕獲了我們不能處理的異常而只是吞噬小,這就會導致邏輯不能恢復到正常狀態,但是應用程式卻還繼續執行,這樣就會導致應用程式存在安全隱患了,我想應該沒有那個人願意用一個看似正常但是卻不能得到正確輸出的應用程式。因此我們應該只捕獲那些我們能夠處理的異常,對於不能處理的應該讓其順著堆疊往上丟擲直到遇到能處理該異常的邏輯程式碼。

  6. 在效能出現問題時再優化程式碼。

  對於一段已經執行穩定的程式碼,不要輕易地去改進優化,尤其在專案的前期。你的改動隨時有可能會引入新的bug,除非效能提示你非得這麼做,而效能測試一般的是在專案後期。

  7. 刪除不用的程式碼而不僅僅是註釋。

  刪除掉那些不用的程式碼而不僅僅是註釋掉它。註釋是應該用來解釋和說明程式碼的,其目的是為了讓別人更加容易看懂程式碼,從而增強程式碼的可讀性的。不要在你的程式中用它來註釋那些不用的程式碼,取而代之的是你應該將這些不用的程式碼刪掉,即使將來你重新需要用到這些程式碼,你也可以從版本控制軟體裡面得到這些程式碼。

  8. 不要將多個類放到一個檔案裡面。

將類定義到單獨的檔案裡面,通過檔名就可以知道是什麼類了,而不需要開啟檔案或者使用全域性搜尋去查詢類定義的位置。將類定義到單獨的檔案裡還可以讓你通過檔案結構可以對映出程式的結構。

相關文章