電腦科學 ^ IT人生 ^ 公益課程

#36 Code Review - 檢視你的程式碼

不論是寫好一個新的功能或是修改 bug,在程式碼都能正確執行並且在 check-in 到 source control server 之前,一定都會有一個 code review 的動作.這件事情通常是由比較資深的人員或對整體程式較為熟悉的人員來執行.Code review 帶來的好處很多,在這裡不一一描述,這對比較資淺的人員或新進的人員來說都是一件好事.因為透過 code review,新進或資淺的人員可以比較快進入情況.有時我們進入了一個龐大程式碼的專案,短時間之久是蠻難完全了解所有的細節以及那個團隊的寫程式碼的文化,所以透過 code review 來了解程式,也算是一種學習.

如果你工作的地方有執行 code reivew 的動作,那真的恭喜你,畢竟教學相長,透過檢視彼此的程式碼是一種良好的學習方式.也因為這跟團隊文化與團隊技術能力與要求上有很大的關係,所以 code review 實在很難說有什麼標準可言.除了程式碼要符合團隊的寫作規定外,要求嚴格的團隊甚至會到極為嚴苛的地步.

接下來,我分享一些我以前在 code review 中學習到的經驗.

1. 每個公司或團隊因為人的不同,所以要求的標準也不同,先不用假設對方是來找你麻煩,如果他對你寫的程式有意見,他一定能說的出原因讓你相信他說的是對的.

2. 如果你寫的是像 Java/C# 之類的物件導向的程式,這樣可能就會有點小複雜.因為同一個功能因每個人對物件的設計會不同,再加上會導入一些 pattern,所以當你不明白全部的內容時,會很容易就不是故意了犯了一些錯.也不用過於放在心上,這種事情是常常發生的.

3. 以我個人而言,程式碼寫的簡單乾淨好閱讀就行了,但是你很可能會遇到資深的工程師要求你要改的更簡潔.例如,

bool visited;
if (isActive == true) {
    visited = true
}

改成

bool visited;
visited |= isActive

基本上這兩個邏輯是一樣的,如果你被要求要寫成下面那樣的語法,就當做是個學習經驗吧!
其他像是變數名稱,物件名稱或屬性名稱也是會有類似的情況.

4. Comment 寫註解.做產品的公司會連註解也有嚴格的格式要求.如果是一般的程式註解,也是要寫到讓人看的懂,否則有寫跟沒寫是一樣的.

所以,如果你是新人,那就好好享受 code review 的過程吧,因為當你遇到一位功力深厚的前輩幫你 code review 時,保證你會收益良多的.


Share:

0 意見:

張貼留言