web項目經理手冊-【3】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過程中不斷完善該文檔。