[非技術文章][轉載] 寫出漂亮代碼的七種方法

首先我想說明我本文闡述的是純粹從美學的角度來寫出程式碼,而非技術、邏輯等。

首先我想說明我本文闡述的是純粹從美學的角度來寫出程式碼,而非技術、邏輯等。以下為寫出漂亮程式碼的七種方法: 

1, 盡快結束 if敘述
例如下面這個JavaScript敘述,看起來就很恐怖:  
 
 
但如果這麼寫就好看得多:
 
你可能會很不喜歡第二種的表述方式,但反映出了迅速返回if值的想法,也可以理解為:避免不必要的else陳述。
 
2, 如果只是簡單的布林運算(邏輯運算),不要使用if敘述
例如:
 
可以寫為:
 
3,敘述段落善用空行分別區隔
例如:
 
很多開發者不願意使用空白,就好像這要收費一樣。我在此並非刻意地添加空白,粗魯地打斷程式碼的連貫性。在實際編寫程式碼的過程中,會很容易地發現在什麼地方加入空白,這不但美觀而且讓讀者易懂,如下:
 
4, 不要使用無謂的註釋
無謂的註釋讓人費神,這實在很討厭。不要標出很明顯的註釋。在以下的例子中,每個人都知道程式碼表達的是“students id”,因而沒必要標出。
 
5, 不要在程式碼文件中留下已經刪除的程式碼,哪怕你標註了
如果你使用了版本控制,那麼你就可以輕鬆地找回前一個版本的程式碼。如果別人大費周折地讀了你的程式碼,卻發現是要刪除的程式碼,這實在太恨人了。
 
6,不要有太長的程式碼
看太長的程式碼實在太費勁,尤其是程式碼本身的功能又很小。如下: 
 
#
我並不是說非要堅持70個字元以內,但是一個比較理想的長度是控制在120個字元內。如果你把程式碼發布在網路上,用戶讀起來就很困難。
 
7,不要在一個功能(或者函數內)有太多程式碼行數
我的一個老同事曾經說Visual C++很臭,因為它不允許你在一個函數內擁有超過10,000行程式碼。我記不清程式碼行數的上限,不知道他說的是否正確,但我很不贊成他的觀點。如果一個函數超過了50行,看起來有多費勁你知道麼,還有沒完沒了的if循環,而且你還的滾動鼠標前後對照這段程式碼。對我而言,超過35行的程式碼理解起來就很困難了。我的建議是超過這個數字就把一個函數程式碼分割成兩個。
 
(這是許久之前,同事轉寄給我,來源不清楚,若是作者看到或是知道出處請告知.....)