微軟資深軟體工程師：閱讀代碼真的很難

 

 原帖地址   原文作者：Eric Lippert    譯者：關關

  

     編者按：原文作者Eric Lippert是一名資深軟體設計工程師，從1996年起一直在微軟開發部門任職，協助設計並實現VBScript、JScript、JScript .NET、Windows Script Host、Visual Studio Tools for Office
和 C#。

　　Escalation的工程師JeremyK在他部落格中問到：

　　你是怎麼教人們快速深入挖掘不熟悉的代碼（不是自己所寫的）？我學習如何編程的方法很傳統
—— 自己動手編碼。但我現在很糾結：到底是集中精神閱讀源碼，還是自己編寫。對我而言，似乎唯一有效方法就是自己寫過。 
　　不是和Jeremy開玩笑，寫代碼的確沒有讀代碼難。

　　首先，我同意你的看法，幾乎很少有人能讀代碼但不會寫代碼。這不像自然書面語或口語，理解他人的意思並不需要去理解他們為什麼要那樣說。比如，如果我說： 

　　“寫代碼有兩種方式：一種嚴格且詳細，另一種模糊且草率。前者產生簡潔分層的婚禮蛋糕，後者卻是意大利麵條。” 

　　上面這句話產生一個平衡且幽默的效果，但即使聽眾和讀者不理解我使用“零照應”和“並列句”這樣的文字技巧，也會理解我要說的意思。但是說到代碼，既要從代碼本身中理解代碼作者的意圖，又要理解代碼產生的預計效果，這兩者都極為重要。 

　　因此，我又回到那個問題了，有些人需要快速切入代碼，但不需要動手寫代碼，那我們如何編寫適合這些人的代碼？ 

　　下面是我在編寫代碼時，儘力去做的事，目的就是使其他人能輕鬆閱讀： 

• 使代碼遵從工具。Object Browsers和Intellisense雖然很好，但我告訴你，我是守舊派。如果找不到我想要的，我會不高興。什麼使得代碼成為可查詢的呢?
  • 像"i"這樣的變數名不好。如果沒有明確的錯誤提示，你就無法輕易尋找代碼。
  • 避免使用是其他名字首碼的名字。比如，在代碼中有個“perfExecuteManifest”，如果再有一個“perfExecuteManifestInitialize”，這就會讓我抓狂，因為每次在源碼中查詢前者時，我不得不費力地過濾掉後者所有的執行個體。
  • “臨時傳遞資料”（tramp data）應使用相同的名字。所謂“臨時傳遞資料”（tramp data），就是指那些傳遞給方法A的變數，還要傳給方法B的變數。這兩類變數實際上是相同的，所以如果它們有著相同的名字，則更好。
  • 別用宏來重新命名東西。如果有個方法叫get_MousePosition，那別這樣GETTER(MousePosition)來聲明該方法。因為我會找不到實際的方法名。
  • Shadowing會引起很多問題，請不要用它。

• 堅持使用一種命名模式。如果你打算用匈牙利命名法，那就堅持並廣泛使用，否則將適得其反。使用匈牙利命名法來記錄資料，而不是儲存類型；記錄普遍事實，而不是臨時條件。 

• 使用斷言來記錄先決條件（preconditions）和後置條件（postconditions）。 

• 別縮寫英文單詞。確切來說，別縮寫成稀奇古怪的形式。在指令碼引擎中，有個變數名叫“NME”，這讓我非常抓狂！它應當叫“VariableName”。

• C語言標準執行階段程式庫的設計不是很優秀。別去效仿它。

• 別寫“聰明”的代碼；當代碼出現問題，維護代碼的程式員沒時間去理解你的聰慧。（編註：這條建議即為：編寫可維護的代碼。） 

• 理解程式設計語言特性的設計初衷，使用這些特性去做它們適合完成的工作，而不是它們能做到的工作。例如：別把異常當做一般的流量控制機制來使用（即便你能做到），而應該用它們來報告錯誤。彆強制把介面指標轉換成類指標，即便你知道這樣沒問題。 

• 按功能單元劃分源碼樹，而不是按組織圖。比如：我目前所在團隊中，有2個根子目錄的名字是“Frameworks”和“Integration”，這是兩個團隊的名字。不巧的是，Frameworks團隊名下有一個叫“Adaptor”的子目錄，而“Adaptor”卻是Integration的子目錄，這就非常令人迷惑。同理，（如果）有著相同子目錄的不同的子樹，有些是用戶端的組件，有些是服務端的組件；有些是管理組件，有些是非管理組件；有些是處理型組件，有些是非處理型組件；有些是零售組件，有些自我裝載工具。這就會亂七八糟的。

     

 
     當然，我實際上根本沒有回答Jeremy的問題——如何調試不是我寫的代碼？ 

　　這取決於我的目的。如果我只是因為一個bug，而深挖一段具體的代碼，我會在調試器中逐步跟蹤所有代碼，寫下我“走過”的調用分支，記錄下哪些方法是特定資料結構的“生產者”，哪些方法是“消費者”；我也會仔細盯著輸出視窗，查看出現的有用資訊；還要開啟異常捕捉器，因為異常通常是問題所在。設定斷點；我會記錄所有和我上面建議相反的地方，因為這些東西很可能誤導了我。 

　　如果我想在理解一段代碼後修改它，我通常是從代碼頭部開始，或者先尋找公用方法。我要知道類是如何?的，它是如何擴充的，它的作用，它是如何嵌入整個代碼中的？我會儘力理解這些東西後，才去瞭解這些特定部分（代碼）是如何?的。這耗時雖更長些，但如果你準備改動複雜代碼，你應當那樣做。