像建築設計師一樣去寫程式

2021-06-27 23:46:11 字數 2199 閱讀 3301

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

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

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

相較之下,很少有程式設計師會在他們開始寫**之前,連乙個粗略的框架都沒有。

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

但漫畫家dick guindon曾經所過:

寫作是發現你想法有多糟糕最好的方式。

藍圖幫助我們理解建築的構架,同樣,在我們開始噼里啪啦寫**之前,我們也需要乙個類似的「藍圖」,也就是「注釋」(specification)。

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

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

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

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

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

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

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

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

我最近要編寫的程式,最多稱得上是「平房」,而非摩天大樓。我會為我的每個演算法附上注釋,有些非常簡單的演算法,我通常只會插上一兩句註解。我有乙個非常簡單的法則來幫助我和其他人了解我的程式:注釋應該盡可能有效地去幫助任何乙個人理解和使用我的**。

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

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

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

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

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

像設計師一樣思考

原文 很多人從未認真思考過設計或設計師,更別提把自己當作設計師了。但是普通人 教師 學生 各 式各樣的工作者 能從設計師和設計師的思維方式中學到什麼?更專業化的職業呢?醫生 科學家 調查工作者 工程師以及其他各種技術領域的專家們又能從平 面設計師和互動設計師的思維方式中學到什麼?有沒有什麼是設計師 ...

像設計師一樣思考 設計師的11個小貼士

像設計師一樣思考 設計師的11個小貼士 多人從未認真思考過設計或設計師,更別提把自己當作設計師了。但是普通人 教師 學生 各式各樣的工作者 能從設計師和設計師的思維方式中學到什麼?更專業化的職業呢?醫生 科學家 調查工作者 工程師以及其他各種技術領域的專家們又能從平面設計師和互動設計師的思維方式中學...

像設計師一樣思考的十貼士

很多人從未認真思考過設計或設計師,更別提把自己當作設計師了。但是普通人 教師 學生 各式各樣的工作者 能從設計師和設計師的思維方式中學到什麼?更專業化的職業呢?醫生 科學家 調查工作者 工程師以及其他各種技術領域的專家們又能從平面設計師和互動設計師的思維方式中學到什麼?有沒有什麼是設計師 無論通過他...