像建築設計師一樣去寫代碼

來源:互聯網
上載者:User

寫代碼和寫文章,從某種程度上是相通的,需要邏輯、構架,也要儘可能的簡練。我們之前說過,創作者的時間表和管理者的時間表是不一樣的,編代碼和寫文章,都是一個孤獨而不能受到幹擾的過程,面對螢幕,就是一場自己與自己的戰爭。 

同樣,如果說建築師最後的成品是建築的話,那麼程式員和軟體工程師最終的成品就是軟體。在實際動工之前,建築師將會將建築的每一個細節,都在藍圖上加以呈現。只是程式員和軟體工程師並不會這麼做。或許,這就是為什麼房子很少倒塌,而軟體卻經常崩潰的原因? 





設計藍圖會協助建築師確定他們的設計是可行的。“可行”並非只是保證不倒塌,它同時還意味著,建築能夠達到預定的服務於人的目標。客戶或者開發商,也是通過藍圖去瞭解一個設計師的想法和他正打算去做的事情。

相較之下,很多程式員在他們開始寫代碼之前,連一個粗略的架構都沒有。 

大部分的程式員都認為:所有不能直接產出代碼的事情都是沒有意義的。思考並不能直接轉換成代碼,但是倘若在沒有一個整體架構之前,就開始匆忙碼字,這也是沒有意義的。在程式員開始寫代碼之前,他們應該先充分理解這些代碼最終所要實現的功能。理解的過程,自然需要去思考,而將思考過程寫下來,對於程式員來說又是件很耗時的事兒。 

但漫畫家 Dick Guindon 曾經所過: 寫作是發現你想法有多糟糕的最好的方式。

藍圖協助我們理解建築的構架,同樣,在我們開始劈裡啪啦寫代碼之前,我們也需要一個類似的“藍圖”,也就是“注釋”(specification)。 

“注釋”不能直接產出代碼,所以被很多程式員忽視。但沒有“注釋”,直接開寫,就好像讓建築承包商沒有設計師的圖紙就直接上陣一樣。 

也有人會說,將程式員和建築師類比,並不合理。因為拆牆重建困難,但刪掉重寫則相對容易,所以,程式員可以先寫著,不滿意再改。 

這種想法是錯的。為什麼呢?因為 Debug 的過程也非常耗時。 

我最近也完善了一些程式,這個過程需要對程式構架本身有個非常清晰的瞭解。我花了接近一天的時間去瞭解整個程式的運作機制,而倘若有注釋的話,這可能只需要 5 分鐘的時間。 

為了避免引入 bug,我需要理解任何小的調整可能帶來的結果。而沒有注釋,使得我必須花很長時間瞭解每條代碼的含義和作用。尤其對於上千行的代碼來說,首先讀懂它就很耗時,想要改掉其中的某行,我必須瞭解小的調整可能對整體架構和前後邏輯造成的影響。最終,在超過一個星期的時間裡我只改了 180 行代碼,而這對一個動輒千行的程式來說,改變算是很小的了。 

Debug 只是寫代碼一個小的組成部分。這數千行的代碼很多我 10 年前寫的,儘管我對它們仍有些許殘存的記憶,但如果有注釋的話,修改代碼的過程會更加順暢,我不僅能在最短的時間裡讀懂整個架構,還可以準確定位我所要修改的部分。 

改別人的代碼就更加困難了,每個人的思維方式都不一樣,如果沒有注釋,我通常要花費兩倍以上的時間,只是為了修改一些細小的錯誤。 

那麼,我所謂的“注釋”又是指什麼呢?“注釋”是指附在代碼之後的,一段形式化規範說明的文字。但需要區分開的是,如果只是去打造一個工具室,我們是不需要一整套摩天大廣告藍圖的,同樣,對於小的演算法來說,我們也不需要給每條代碼加上註解。 

我最近要編寫的程式,最多稱得上是“平房”,而非摩天大廣告。我會為我的每個演算法附上注釋,有些非常簡單的演算法,我通常只會插上一兩句註解。我有一個非常簡單的法則來協助我和其他人瞭解我的程式:注釋應該儘可能有效地去協助任何一個人理解和使用My Code。 

一旦我知道一行特定代碼要做的事情後,寫的過程其實是非常簡單而直接的。也有些程式需要用到非常規演算法,這時我會寫下我演算法的主要思路,來試探其可行性,同時也協助我更高效的 Debug。 

除了那些特別重要的代碼,通常我的注釋都是非正式的。在過去的十年裡,需要我寫準確並正式注釋的次數並不多。但對於一個非常複雜的系統來說,注釋的重要性不言自明。很少有工程師會在構建一個複雜系統時,花時間去寫好注釋。有些學校也會教你怎麼寫注釋,但更多時候都是教你如何寫好代碼。這需要實踐,如果你沒有畫過搭建一座平房的圖紙,你很難直接畫出摩天大廣告的藍圖。 

寫好注釋也沒有一個簡單的準則,但有一點你要盡量避免,那就是用代碼去解釋代碼。就好像你不能用兩個人們都不理解的東西,用其中一個去解釋另外一個。建築師也不能直接用磚塊來告訴你,他想搭建一個什麼樣的房子。 

瞭解一個複雜的系統,最好的辦法就是將其核心用簡單的概念,抽象的概括出來。初中數學的一些基本概念可以用來協助你寫好注釋,比如你可以用一些集合、方程和簡單的邏輯來解釋你的代碼。對於一些複雜的演算法,你也可以引入數學裡沒有過的概念來加以解釋。總的來說,如果你的注釋偏離一些抽象的數學基本概念越遠,理解起來也就越困難。 

思考並不能保證我們不犯錯,但不思考,犯錯是無法避免的。注釋能協助我們將錯誤最小化,同時它還能提高我們改錯的效率,節省我們的時間。



相關文章

Cloud Intelligence Leading the Digital Future

Alibaba Cloud ACtivate Online Conference, Nov. 20th & 21st, 2019 (UTC+08)

Register Now >

11.11 Big Sale for Cloud

Get Unbeatable Offers with up to 90% Off,Oct.24-Nov.13 (UTC+8)

Get It Now >

Alibaba Cloud Free Trial

Learn and experience the power of Alibaba Cloud with a free trial worth $300-1200 USD

Learn more >

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。