像建筑設計師一樣去寫程序

        英文原文：Why We Should Build Software Like We Build Houses

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

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

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

        相較之下，很少有程序員會在他們開始寫代碼之前，甚至連一個粗略的框架都沒有。

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

        但漫畫家 Dick Guindon 曾經所過：

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

Writing is nature’s way of letting you know how sloppy your thinking is.

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

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

        也有人會說，將程序員和建筑師類比，是不合理的。因為拆墻重建困難，但刪掉重寫則相對容易，所以，程序員可以先寫著，不滿意再改。

        這種想法是錯的。為什么呢？因為 Debug 的過程非常耗時。

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

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

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

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

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

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

        注釋

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

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

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

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

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

        Via Wried