1.代碼書寫規範:
(1)代碼不僅僅要足夠高效,減少備援,而且在合作過程中要易于合作人的閱讀以便更高效的工作。而且命名要盡量避免二義性;
(2)在編寫過程中,應養成寫空白{ }的習慣,注意分行;
(3)下劃線一般用于作用域和變量;
(4)使用Pascal和Camel形式去命名,區分函數和變量;
(5)注釋應放在函數頭,盡量隻用ASCII字元;
2.代碼設計規範:
(1)函數隻做一件事;
(2)程式邏輯清晰易懂;
(3)用斷言Assert判斷程式應有的正确反應,if()、else if()來處理可能的錯誤,else用于錯誤測試通過後繼續程式的運作;
(4)對于簡單的資料類型,盡量不用類傳遞,應用指針傳遞;
(5)公共/保護/私有成員按照次序說明(不要混在一起說明);
(6)僅在必要時,才自定義操作符,才使用類型繼承;
3.代碼複審:
(1)軟體工程中最基本的複審手段,就是同伴複審。對于至關重要的代碼,我們要請不止一個人來做代碼複審。
(2)複審要找出錯誤:編碼錯誤、邏輯錯誤、算法錯誤、潛在錯誤和回歸性錯誤。
複審還可以找到改進的地方,熟悉代碼、學習知識
(3)代碼複審步驟:
【1】通過編譯;
【2】程式員測試過代碼,可以加上outputDebugString監視程式控制流;
【3】程式員提供最新代碼,和檔案差異分析工具(Git目前應該可以做到);
【4】面對面複審時,複審者積極提出意見;
【5】讓所有問題得到滿意的答複;
【6】代碼要考慮日後更新、維護留出餘地;
【7】代碼複審後:更正明顯錯誤,記錄暫時無法更正的錯誤;
(4)建立代碼複審的核查表;
4.結對程式設計:
(1)結對程式設計注意角色配置設定、角色交換、記錄預測和實際時間;
總結
實際上本文就是很好的書寫規範。