Web專案經理手冊之Code Review

     Code Review是保證專案中程式碼質量非常重要的一個環節，其主要工作是：
1、發現程式碼中的bug；
2、從程式碼的易維護性、可擴充套件性角度考察程式碼的質量，提出修改建議。

1、程式碼中的bug主要會出現在下列兩個地方：
(1) 與商業邏輯無關的bug。
        比如，系統中開啟的流／檔案／連線等沒有及時關閉；或是存在thread safe問題，或是存在效能低下問題等，這類問題對有經驗的開發人員是比較容易發現的。

2、與商業邏輯相關的bug。
        這類bug是非常隱蔽的，如果有對產品不熟悉的人蔘與該產品的專案開發，容易出現這類的bug。為了避免這類bug的出現，我們除了在Use Case和Test Case中詳細描述以正確指導開發人員並在測試時能及時發現它之外，Code Review也是不可缺少的保證環節。
        我們希望程式碼的稽核者對產品非常熟悉。

3、什麼樣的人承擔程式碼稽核者Code Reviewer？
(1)、比較熟悉相關商業邏輯。
(2)、有豐富的程式設計經驗。
兩者缺一不可。

4、程式碼Code Review的步驟，這些是我在平時工作中的經驗總結，目前也是按照這個步驟在做。
(1)、程式碼編寫者和程式碼稽核者坐在一起，由程式碼編寫者按照UC依次講解自己負責的程式碼和相關邏輯，從Web層->DAO層；
(2)、程式碼稽核者在此過程中可以隨時提出自己的疑問，同時積極發現隱藏的bug；對這些bug記錄在案。
(3)、程式碼講解完畢後，程式碼稽核者給自己安排幾個小時再對程式碼稽核一遍。
        程式碼需要一行一行靜下心看。同時程式碼又要全面的看，以確保程式碼整體上設計優良。

(4)、程式碼稽核者根據稽核的結果編寫“程式碼稽核報告”，“稽核報告”中記錄發現的問題及修改建議，然後把“稽核報告”傳送給相關人員。

(5)、程式碼編寫者根據“程式碼稽核報告”給出的修改意見，修改好程式碼，有不清楚的地方可積極向程式碼稽核者提出。

(6)、程式碼編寫者 bug fix完畢之後給出反饋。

(7)、程式碼稽核者把Code Review中發現的有價值的問題更新到"程式碼稽核規範"的文件中，對於特別值得提醒的問題可群發email給所有技術人員。

5、責任：
        程式碼編寫者，程式碼稽核者共同對程式碼的質量承擔責任。這樣才能保證Code Review不是走過場，其中程式碼編寫者承擔主要責任，程式碼稽核者承擔次要責任。

6、Code Review必備的文件：
      “程式碼稽核規範”文件：記錄程式碼應該遵循的標準。程式碼稽核者根據這些標準來Code Review程式碼，同時在Code Review過程中不斷完善該文件。

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/14710110/viewspace-371923/，如需轉載，請註明出處，否則將追究法律責任。