為什么我要豎向?qū)R程序代碼,你也應(yīng)該這樣做
最近在HackerNews上Linux內(nèi)核編碼風(fēng)格的討論非常熱鬧。
討論的進行中,我的一個回復(fù)觸發(fā)了另外一場關(guān)于是否應(yīng)該豎向?qū)R代碼的口水仗。我堅持我的觀點!下面讓我來解釋一下為什么要豎向?qū)R。
為什么要豎向?qū)R代碼?
舉一個簡單的例子:
- int robert_age = 32;
- int annalouise_age = 25;
- int bob_age = 250;
- int dorothy_age = 56;
相較而言,下面的寫法更易讀:
- int robert_age = 32;
- int annalouise_age = 25;
- int bob_age = 250;
- int dorothy_age = 56;
只要用眼睛一掃,我們就能發(fā)現(xiàn)”bob_age”數(shù)字異常。我可以去輕松的識別這些變量都是數(shù)字,不需要拿眼睛一個個對比。
這種編碼風(fēng)格并不是被廣泛的接受。所以,我需要解釋一些這種風(fēng)格的好處。
代碼的可讀性
90%的編程活動是為了解決問題。另外90%是用來理解代碼是如何解決問題的。
閱讀代碼跟閱讀小說沒多大區(qū)別。我們希望作者能把他的想法寫明白,不需要陳詞濫調(diào)長篇累牘,但同時要遵守所使用的語言的語法。
事實上,Linux內(nèi)核編碼風(fēng)格里十分強調(diào)這一點。你給變量的命名同它的作用同等重要。
看一下下面的這段代碼:
- var thinG=doIt(thestuff,MORE_sTuff); /* LOL! */
就算你是十分解這段代碼,你讀起它來也十分費勁。
- var totalBill = apply_tax(initialBill, taxRate);
通過給予變量有意義的命名,空格,大小寫區(qū)分,我們能讓這段代碼更清晰。這意味著接手我們的代碼的下一位程序員能更容易的理解它。
為什么要使用Monospace字體?
關(guān)于代碼編輯器應(yīng)該使用monospace字體還是proportional字體的爭論,從未停息也不會停息,兩派人各有所好。
有些異教徒會告訴你proportional 字體是***的——忽略這些人吧。
最終是為可讀性。什么方法能最簡單的幫助我們理解代碼?所以IDE才會有代碼高亮配色,這樣你就能輕松的分辨“foo”究竟是一個函數(shù),是一個變量,是一個常量,還是一個注釋。只要是能幫助我們理解代碼的東西都是好東西!
編輯器的問題
有趣的是,我遇到的很多批評的聲音不是說代碼豎向?qū)R的好壞,而是批評我的代碼編輯器不行。
你這樣做會破壞使用diff對比版本差異時的可讀性和有效性。比如,本來只是一行是有一個變量有bug,你能為了對齊變量改動了很多行,影響了查看關(guān)鍵修改處。也有能夠忽略空格的diff技術(shù),但至少你這樣做得不償失。
Andreas van Cranenburgh
…還有…
假如說,你有50行代碼要豎向?qū)R,你把所有的值對對齊距離最遠的那一行,而增加一個更大距離的行,你需要修改50行。我就遇到過這樣的問題,最終發(fā)現(xiàn)這樣做是錯誤的。
scrollaway
他們說的是對的——在某些情況下。但關(guān)鍵是他們不會使用更好工具。
我記得Elastic Tabstops提供的一個技巧——如何自動對齊代碼塊:
正確的工具能輕松的完成這樣的任務(wù)。計算機就是用來為我們干這些枯燥、重復(fù)的事情的-CPU的工作很廉價,我們可以“浪費”CPU的工作來讓我們的代碼更清晰可讀。
在Linux 內(nèi)核代碼中還有大量的例子能說明豎向?qū)R代碼能讓代碼更適合人類閱讀。
豎向?qū)R代碼并不是在所有情況下都適用——但對于大多數(shù)情況,它的好處是大大的。
代碼是我們表達我們的思想的媒介。如果你的工具使得理解這些思想更困難,那說明工具需要改變,而不是我們。