引言
Code Review的作用和意義已在很多技術團隊內達成共識,可是很多時候並未被有效執行,甚至被認爲是一項費時費力的工作。藉助一些工具可以更容易,更有效率地來進行Code Review,本文介紹的Jupiter即是其中之一。
Jupiter概述
Jupiter是一款開源的Eclipse插件,以XML形式存儲review數據,通過SVN/CVS將review結果在團隊內共享。一個很方便的功
能是其建立了review問題跟具體源代碼的對應關係(通過點擊review問題列表中的問題可以跳轉到對應的代碼段,通過點擊代碼段上的review問
題標記可對應到具體的問題描述),review問題列表支持各種filter規則(根據review問題狀態、責任人等,通過這個filter可以列出具
體階段需關注的問題)。
Jupiter安裝
通過Eclipse的update site 在線安裝:http://jupiter-eclipse-plugin.googlecode.com/svn/trunk/site/
或下載後安裝:http://code.google.com/p/jupiter-eclipse-plugin/downloads/list
安裝後可能需重啓Eclipse。
Jupiter的Code Review流程
Jupiter的Code Review流程爲以下幾步:
1.建立review任務:代碼修改者或TL建立review任務,指定需評審的代碼文件、參與評審的人員、定義問題類型及嚴重級別等。
2.個人評審階段:開始個人獨自評審,將可能出現的問題加入問題列表。
3.團隊評審階段:團隊成員坐在一起,討論個人評審階段的問題,確定是否需要修復並分配解決人員。
4.問題修復階段:每個人修復分配給自己的問題,修復後修改問題狀態。
下面圖文介紹具體的操作(點擊圖片看大圖)。
1.建立review任務
在“Package Explorer”或“Navigater”裏,右鍵點擊項目名稱,選擇“Properties”顯示項目屬性窗口。
選擇“Review”將顯示Jupiter屬性
點擊“New”按鈕打開新建Review ID對話框,輸入Review ID(需符合文件命名規則)和Description。
選擇需要Review的文件,可一次選擇多個
需要Review的文件列表,可繼續Add或選中後Remove
添加後的Reviewer列表,可繼續Add或選中後remove
選擇評審負責人
接下來的幾步是設置問題類型及嚴重級別和filter,根據實際情況修改或用默認值,finish後會在工程根目錄生成.jupiter文件,提交該文件到SVN。
2.個人評審階段
從SVN上更新最新的源代碼和.jupiter文件,在Eclipse裏“Window”-“Open Perspective”-“Other”選擇“Review”打開Review視圖
選擇“Individual Phase”
選擇Project Name(項目名稱),Review ID(review任務)和Reviewer ID(評審人員)
“Review Table”右邊第一個下拉菜單顯示了需Review的文件
選擇文件就可以開始review了,發現問題時,光標停在問題代碼處,點擊鼠標右鍵選擇“Add Review Issue……”
在“Review Editor”裏選擇問題類型及嚴重性,添加概要和詳細描述,保存。可以看到增加了Review問題的代碼會在行首處有標記。
個人評審完畢後將Jupiter評審數據目錄(默認爲review)下的數據上傳到SVN。
3.團隊評審階段
團隊成員坐在一起,從SVN上更新最新的Review數據,從review試圖中選擇“Team Phase”,點擊“Review
Table”中的問題會跳到對應的代碼,一起討論代碼是否確實存在問題,在“Review Editor”裏分配修復人員及解決方式,保存。
團隊評審完畢後將Review數據上傳到SVN。
4.問題修復階段
個人回到自己的工作機,更新最新的review數據,從review試圖中選擇“Rework Phase”,會在“Review
Table”裏列出分配給自己的問題,逐一修復,並在“Review
Editor”將問題狀態改爲“Resovled”,保存並將review數據上傳到SVN。
Rework完成後,各位評審者再次檢查,如果檢查未通過,可將問題狀態改爲“Re-Opened”,確認問題修復後將問題狀態改爲“Closed”,
至此,一個Code Review流程結束。
參考資料:
http://code.google.com/p/jupiter-eclipse-plugin/wiki/UserGuide