全文共1780字，預計學習時長4分鐘
注意！注意！想要作為優秀的程序員必須遵守一些不成文的規定。本文不是在討論算法、數據結構、軟件架構和程序設計，而是在討論一些更基本、更重要的東西：可讀性。
源代碼是程序員耗盡了心血和精力的作品，所以不應當存在“快刀斬亂麻”的現象。忽視這些規定看似讓代碼生成速度加快，但事實上往往導致事倍功半。
代碼敲一次，閱讀無數次。因此，優化代碼提高可讀性顯得尤為重要。為了幫助生成高度可讀的代碼，本文歸納總結了必須遵守的3個重要規定。遵循這些規則可以幫助使用代碼的人員維護、擴展和調整代碼。此外，可讀性高的代碼更不容易出錯。
這三個技巧最好的地方在於: 可以立即實現。不需要訓練時間。僅僅需要幾分鐘就能蛻變成更優秀的程序員！
使用描述性的變量和函數名
程序代碼往往包含上千單詞。當然，也有篇幅較短的代碼。使用自解釋變量和函數名使代碼更容易閱讀、理解、維護和後續擴展。舉個例子：
在編寫這段代碼時，開發人員確切地知道要實現的是哪種功能。但是，其他人能理解嗎？這就要看靈感和緣分了。開發人員可以添加一條註釋來描述這段代碼的用途，但是使用描述性變量名能夠更直觀地告訴讀者相關信息，比如：
看！現在是不是更容易理解了。僅通過使用描述性變量名，讀者就可以立即瞭解該代碼能將華氏溫度（Fahrenheit）轉換為攝氏溫度（Celsius）。現在定義一個函數實現上述代碼功能，並觀察根據函數名和參數名對可讀性的影響程度。
“簡短”版：
“細節補充”版：
很明顯：比起只用單個字母表示變量和函數名的“簡短”版，“細節補充”版需要花費更多的打字時間。
但是，理解這兩個版本的代碼又需要多長時間呢? 自解釋代碼不僅為讀者節省了許多理解代碼的時間，同時也為開發人員節省大量時間。為了更改程序細節或者編寫拓展程序，開發人員經常需要回顧數月前編寫的代碼。然後就一臉懵的看著屏幕：“我滴個神啊，我都寫了啥？任何可以優化閱讀性的方法都值得付出額外的打字時間。
使用適當的縮進
因為Guido van Rossum 決定在他設計的Python編程語言中強制執行縮進，所以使用Python進行編程的讀者可以跳過本節。
如果使用的是如C、C++、Java、JavaScript、PHP、C#、PHP等其他受眾良多的編程語言，那麼牢記這條技巧：
按層次縮進代碼。
可以使用製表符或者空格，空格按3次或者按4次也可按照開發人員的喜好而定。只要記住縮進在編程中是必須的就OK了。接下來通過比較一些JavaScript代碼來進一步說明。這段代碼：
· 將100至110華氏度換算成相應攝氏度。
· 將轉換後的值四捨五入至個位(使數據變為整數)。
· 將所有偶數攝氏度值輸出到控制檯(這是通過使用模數運算符”%”完成的，該操作符返回整數除法的餘數。因此，11% 2 =1,12% 2 = 0)
沒有縮進的版本：
有縮進的版本:
代碼中還添加了一些空白行來進一步結構化代碼。這兩段代碼中哪個的可讀性更高呢?
恰當地使用函數
通過使用函數可以構建可重複使用的代碼塊。這些還可以使代碼更結構化、更具可讀性和可理解性。能夠避免重複的代碼是函數最重要的特性。
定義函數(或類、模塊等等，這取決於使用哪種編程語言)可以解決在代碼庫中多次出現相同的代碼段的冗雜狀態。下述示例就是很好的示範：
上述代碼輸出華氏度數值和相應的攝氏度數值。很明顯，上述代碼存在重複性代碼段，這種情況下創建一個函數就可以更快速地完成上述功能：
更清爽對吧！代碼看起來更乾淨、更簡潔。而且，它比前一個示例更具描述性。那個公式只會在定義ConvertAndPrint函數時出現一次。如果只是想把華氏度轉換成攝氏度但是不顯示這些數據呢?可以通過定義不同的函數來實現：
有木有！這種方法構建了含有自解釋代碼的構建塊，以便在不同的程序設計段中以多種方式重複調用這些構建塊。
到這就結束了？No！
還是有的地方代碼重複性很高啊。PrintFahrenheitAndCelsius 函數需要輸入4個值。那麼只想轉換3個值的時候怎麼辦呢？想轉換300個值的時候又該怎麼辦呢？當然有一個更好的方法！
根據使用的編程語言不同，抽象化函數的參數數量的方法可能不太一樣。但是，大多數開發人員會通過使用容器（如矩陣或者List）解決這個問題。
最後的改變使函數更優越：
· 它更短，更容易閱讀，
· 限制更少，更加通用。
結語
遵循一些簡單的規定（規範化指導）能使源代碼將更容易閱讀(從而進一步理解、維護和擴展)。
同時，使用函數(或者其他編程語言的任何抽象方法)來創建可重複調用的構建塊，抽象化參數使代碼限制更少、適用範圍增大。
對函數和變量恰當地重新命名可以增加源代碼的可讀性。就像讀故事一樣清晰、簡單、容易理解。
使用這三個技巧，手中的代碼將宛若重獲新生，熠熠生輝。
留言 點贊 關注
我們一起分享AI學習與發展的乾貨
歡迎關注全平臺AI垂類自媒體 “讀芯術”