我們不提倡以貌取人，但是人確實(shí)有美丑之別，美人讓人賞心悅目，丑人讓人。。。不那么賞心悅目。

代碼也一樣。

計(jì)算機(jī)編程里有一組相關(guān)的概念，一個(gè)叫做Prettify（美化），一個(gè)叫做Uglify（丑化）。

Prettify的典型應(yīng)用是在JSON/XML/HTML這些數(shù)據(jù)的呈現(xiàn)上，對(duì)眼睛不友好的json，烏央烏央的一坨，讓人看起來(lái)很費(fèi)勁：

［{“name”：“Mac”，“l(fā)anguage”：“python”，“major”：“computer application”}，{“name”：“Ava”，“l(fā)anguage”：“C++”}，{“name”：“Ryan”，“l(fā)anguage”：“Java”}］

對(duì)眼睛友好的json，層次結(jié)構(gòu)清晰明了：

［

{

“name”： “Mac”，

“l(fā)anguage”： “python”，

“major”： “computer application”

}，

{

“name”： “Ava”，

“l(fā)anguage”： “C++”

}，

{

“name”： “Ryan”，

“l(fā)anguage”： “Java”

}

］

而Uglify（以及Obfuscate/混淆）的應(yīng)用場(chǎng)景，是在不改變代碼邏輯的情況下讓代碼很難理解，以減少代碼被剽竊抄襲的可能，起到保護(hù)代碼作用。比如，以下代碼很容易理解：

def get_user（username）：

pass

username = ‘a(chǎn)va’

user = get_user（username）

以下代碼和以上代碼在功能上是同等的，但是非?！胺慈祟?lèi)”：

def a121（rw24__fdx）：

pass

kwlekf_fw12q= ‘a(chǎn)va’

II11LL =a121（kwlekf_fw12q）

這個(gè)例子看似很蠢，但是它可以讓我們更直觀地看到代碼可讀性（Readability）的重要性，從而引起一些反思：自己寫(xiě)的代碼可能是不是也像是被“丑化”過(guò)，讓人看得視力下降，血壓上升，怒從心頭起，惡向膽邊生？

代碼能正確工作，這僅僅是寫(xiě)代碼的基本要求，高質(zhì)量的代碼，一定具有良好的可讀性。

在某種程度上來(lái)說(shuō)，寫(xiě)代碼是一種社交行為，其溝通的對(duì)象不僅包括計(jì)算機(jī)（使之可以被執(zhí)行），也包括人。

這其中牽涉到人的環(huán)節(jié)很多，包括評(píng)審代碼和后續(xù)的代碼維護(hù)（修復(fù)缺陷、重構(gòu)改進(jìn)）等等，進(jìn)行這些操作有一個(gè)基本前提：理解代碼邏輯！用更直白的話(huà)講，就是能看懂。

如何才能讓人更容易看懂？

遵循KISS原則： Keep It Simple and Stupid！簡(jiǎn)單直白，一目了然！

我們不妨來(lái)賞析兩段詩(shī)詞：

“長(zhǎng)橋臥波，未云何龍？復(fù)道行空，不霽何虹？高低冥迷，不知西東”，出自杜牧的《阿房宮賦》，描寫(xiě)了阿房宮的氣勢(shì)。

“不敢高聲語(yǔ)，恐驚天上人”，出自李白的《夜宿山寺》，描寫(xiě)了山寺高樓。

這兩段詩(shī)詞具有一定的可比性：

都是描寫(xiě)建筑

作者年代相近（事實(shí)上，杜牧比李白晚生了一個(gè)世紀(jì)，離我們的年代更近）

都是傳世名篇。

但是，他們的風(fēng)格顯然不一樣。

《阿房宮賦》引經(jīng)據(jù)典，辭藻華麗，但是不容易看懂，讓人望而生畏?！兑顾奚剿隆酚迷~簡(jiǎn)單卻絲毫不犧牲詩(shī)意的表達(dá)，所以老少咸宜，販夫走卒皆可傳誦。

假如，《阿房宮賦》問(wèn)世之后，我們發(fā)現(xiàn)阿房宮其實(shí)還有一處奇特的噴泉景觀沒(méi)有被寫(xiě)進(jìn)去。如果讓我在原文基礎(chǔ)上加上相應(yīng)的內(nèi)容，我會(huì)很惶恐，因?yàn)檫B原文都沒(méi)看懂，談何修改和擴(kuò)展？不敢，不敢！

但是，如果讓我來(lái)擴(kuò)展《夜宿山寺》，雖然水平和詩(shī)仙有云泥之別，但是因?yàn)檫@首詩(shī)良好的可讀性，愚笨如我也讀懂了，或許，我可以斗膽以狗尾續(xù)貂。。。

代碼需要讓計(jì)算機(jī)明白我們想讓它做什么，同時(shí)也需要讓人（其他程序員）可以很容易地明白其中的意圖和思路。詩(shī)詞的可讀性影響詩(shī)詞的傳承，代碼的可讀性影響代碼的傳承（可維護(hù)性），在這個(gè)方面，詩(shī)詞和代碼是相通的。

寫(xiě)到這里，我的心情突然緊張起來(lái)了。我總是教訓(xùn)徐小胖寫(xiě)作文天馬行空離題萬(wàn)里，沒(méi)想到，我自己的毛病也沒(méi)有改過(guò)來(lái)。為了打造嚴(yán)肅的軟件編程技術(shù)公眾號(hào)，我以后要爭(zhēng)取做到扣題。

原文標(biāo)題：漫談代碼可讀性

文章出處：【微信公眾號(hào)：Linuxer】歡迎添加關(guān)注！文章轉(zhuǎn)載請(qǐng)注明出處。

責(zé)任編輯：haq