史上最最佳軟體開發實踐指導

aqee發表於2013-03-01

　　每過一段時間，我都能讀到一些好東西，它是如此的深刻見解，寫的如此的清晰，如此的條理，我必須把它收錄進我的個人“史上最佳”聖物集裡。最近，我新收錄了一篇，非常棒的一篇叫做《Best Practices for Scientific Computing》的文章，我希望每個來讀本文的讀者都找個時間讀讀它。我在這裡列出它的要點，是要鼓勵你去閱讀完整的全文。寫的真是非常好。

  1. 給人寫程式，而不是給計算機。
    1. 一個程式，對於閱讀它的人來說，不應該要求讀者一次性的在大腦里載入過多的背景/相關知識。
    2. 命名需要一貫、明確、有意義
    3. 程式碼風格和格式要統一一致
    4. 軟體開發中的各種工作都要分割成1小時左右的任務
  2. 重複性的工作自動化。
    1. 讓計算機去做重複性的工作
    2. 把最近使用過的命令存到一個檔案裡，以備複用
    3. 使用編譯工具來自動化系統流程
  3. 用計算機做歷史記錄
    1. 用軟體工具來自動跟蹤計算機的工作
  4. 逐步改進。
    1. 每次做一小步，及時獲得反饋，及時糾正
  5. 使用版本控制。
    1. 使用一個版本控制系統
    2. 所有由手工建立的東西都要放到版本控制系統裡
  6. 不要重複自己(或他人)。
    1. 系統中的每一段資料都要有一個權威的單一的存在
    2. 程式碼應該模組化複用，而不是考來粘去
    3. 複用程式碼，而不是重寫程式碼
  7. 準備好對付錯誤的方法
    1. 在程式中增加斷言，檢查它們的各種操作
    2. 使用現成的單元測試框架
    3. 測試程式時借鑑所有的可用的經驗
    4. 把bug做成測試用例
    5. 使用一個有程式碼指令的除錯工具
  8. 只在軟體能正確的工作後才可優化。
    1. 使用監控工具找到瓶頸
    2. 儘可能的用高階語言寫程式
  9. 文件裡描述的應該是設計思路和目的，而不是技術細節。
    1. 描述介面和原因，而不是實現
    2. 重構程式碼，而不是註釋解釋執行原理
    3. 引用其它程式時嵌入其它程式的文件
  10. 協作
    1. 程式碼合併前進行程式碼審查
    2. 當幫帶新成員或解決特別詭異的問題時使用結對程式設計

　　我要額外提到的是這個：

　　11. 維新舊程式碼。

　　如果你還在猶豫不決是否去看那篇文章，那你先去看看它裡面列出的引用67部關於計算機的著作和文章。正如我說的，這篇文章是“史上最佳”。

　　英文原文：Best Best Practices Ever

相關文章