[我的總結]Code Review

是什麼

代碼審查（英語：Code review）是指對計算機源代碼系統化地審查，經常使用軟件同行評審的方式進行，其目的是在找出及修正在軟件開發初期未發現的錯誤，提高軟件質量及開發者的技術。代碼審查常以不一樣的形式進行，例如結對編程、非正式的看過整個代碼，或是正式的軟件檢查。

——維基百科

爲何

1. 提早發現代碼中的潛在錯誤。當咱們修改較大量的代碼時，一般會遺漏一些細節。Code Review能夠更好的幫助咱們發現潛在的問題，同時以更低的成本進行修復。

2. 分享知識。在Code Review中，知識的分享一般是雙向的。咱們能夠經過閱讀別人的代碼或者其餘人提的Comments學到東西。尤爲是後者每每可以給咱們帶來更多的幫助。由於今天別人的錯誤，可能明天咱們就會犯。其次，咱們能夠經過給出comments來向其餘人分享咱們的知識。若是這些知識並不徹底正確，你們能夠在討論的過程當中有更大的獲益。

3. 使整個組瞭解彼此的工做。人們能夠經過review其餘人的代碼及時的瞭解到其餘人的進度。

個人經驗與教訓
在這方面，我犯了幾個錯誤：

1. 在剛開始的時候，碰到別人給我作code review，對於不少comments我都是抱着很感謝的態度，可是對於一些comments則不覺得然。可是其實，人家只是從不一樣的角度看待code。好比，某個地方有兩種寫法，人家建議你採用其中的某一種的緣由並非另一種不行，而是爲了保持一致的編碼風格，或者遵循一些準則。這種時候，大能夠走過去問問爲何，而後共同決定採起什麼樣的action。
2. 不敢給別人提comments。不少時候，對於能夠提出來，也能夠不提的東西，我就放過了。可是其實，若是我提出來，可能會讓本身和同事從討論中學到更多東西，甚至我以爲的這個點是個人一個誤區，能夠經過這個機會糾正。
3. 沒有及時的作code review。隨着團隊轉型，總體工做節奏不斷提升，不少時候會專心在本身的事情上而忽視了code review。可是其實不管從我的仍是團隊的角度，code review的ROI（Return On Investment）都至關高。對於團隊的好處不言而喻，對於我的而言，及時的code review每每可以幫咱們樹立更好的名聲，至少在咱們須要他人幫咱們作code review的時候會更容易地得到幫助。

從過去一段時間的實際工做中，我以爲從code review的發起者這邊，咱們能夠：

1. 在別人可能有疑問的地方，把本身的想法寫成註釋。這樣不止是此次code review的人，之後看你代碼的人也能知道爲何。這個別人頗有可能就是幾個月以後的本身。

2. 發code review以前，本身先完整的看一遍。把一些可能犯錯的模式再檢查一遍。

3. 邀請最小必要集來進行code review。邀請的人越多，會take action的人越少……

從reviewer的角度來講，咱們能夠：

1. 及時的完成code review
2. 不要懼怕給comments或者sign-off
3. 除了看代碼自己，還應該從其餘人的comments中汲取精華
4. 要確定對方寫的好的地方