軟體開發最佳實踐

iteye發表於2014-05-06

  本文從《Best Practices for Scientific Computing》論文中整理出了8大條軟體開發的最佳實踐,希望對你有所幫助。

  1.  為人編寫程式,而不是為電腦

  • 一段程式不應該要求其閱讀者能夠比電腦記憶體記住更多的東西
  • 變數名稱要保持一致、獨特、有意義
  • 程式碼的風格要保持一致

  2.  一些工作讓計算機去做

  • 重複的工作交給計算機
  • 將最近使用的命令儲存在一個檔案中,以便後期重複使用
  • 使用一個構建工具來自動化工作流程

  3.  增量式改進

  • 將工作分為若干個小步驟,快速反饋,及時修正
  • 使用一個版本控制系統
  • 將手動建立的所有東西都放入版本控制系統中

  4.  不要重複自己(或他人)

  • 每一塊資料必須在系統中有一個單一權威的表徵
  • 模組化程式碼,而不是複製和貼上
  • 重用程式碼,而不是重寫程式碼

  5.  對錯誤進行規劃

  • 在程式中新增斷言,以檢查其操作
  • 使用現成的單元測試庫
  • 將bug轉化成測試用例
  • 使用一個符號偵錯程式

  6.  軟體正常工作後再進行優化

  • 使用分析器來確定程式的瓶頸
  • 儘可能使用高階語言來編寫程式碼

  7.  記錄專案的設計和目標,而不是記錄技術細節

  • 記錄介面和用途,而不是實現
  • 重構程式碼優先於解釋它是如何工作的
  • 將文件作為軟體的一部分

  8.  協作

  • 對預合併的程式碼進行審查
  • 在帶新人和處理棘手的問題時使用結對程式設計
  • 使用一個問題追蹤工具

  詳細內容:Best Practices for Scientific Computing

相關文章