如何進行CodeReview

2022-06-21 02:42:10 字數 802 閱讀 6381

**規範主要分為風格規範與設計規範兩大類:

主要是文字上的規定,看似表面文章,實際上非常重要。

具體有如下幾個方面:

(1)縮排

(2)行寬

(3)斷行/空白行

(4)括號

(5)命名(字母、下劃線、大小寫)

(6)注釋

a、單行注釋

b、多行注釋

c、變數/方法/類/包注釋

牽涉到程式設計、模組之間的關係、設計模式等方方面面的通用原則。

主要有如下幾個方面:

a、方法命名

b、方法引數(入參/返回值)

c、方法的職責

比如:避免out型引數、用列舉替代boolean、同型別引數最好間隔開、超過4個引數最好抽象成乙個類、引數和返回值最好不傳null、用衛述句減少if巢狀、方法連續呼叫要注意空指標、for迴圈優於while

比如:異常的抽象層次應該與方法所在的層次一致,業務層方法要對底層異常進行轉譯為業務異常

比如:在某乙個層進行防禦式校驗,某一層按約定不做引數校驗;比如呼叫到的外部介面封裝為facade防腐層;

比如:快速/及時、獨立、可重複、覆蓋主要**路徑、無***

主要根據團隊設定的**規範,來review團隊成員的**,大致有以下幾個方面:

比如:命名、注釋

比如:功能與需求有偏差;引數傳遞順序出錯;方法的邊界條件有沒有考慮等

比如:之前的功能回歸測試不通過

比如:考慮大資料量、大併發量下的效能下sql是否有問題?是否會有記憶體洩露?死鎖等

比如:可擴充套件性/過度設計

——參考《構建之法》

如何進行Code Review

code review應該怎麼做 如何高效迅速的進行codereview 下面推薦一些 code review 工具 crucible atlassian 內部 審查工具 gerrit google 開源的 git 審查工具 github 程式設計師應該很熟悉了,上面的 pull request 在...

《轉》如何進行code review

code reivew是保障 質量的實用方法之一,這裡簡單分享下個人code review的經驗。建議只當案例來看,因為不同專案 不同團隊所做的事情 所具備的技術背景也是不同的,當然也會有些通用的點。先問下,你所在的公司有code review的習慣不?你所在的團隊呢?你個人呢?如果沒有的話,為啥會...

如何進行高效迅速的CodeReview

背景 第一次參加 codereview 不知道該如何去做,也不知道為什麼去做,後來參加多了,慢慢了解了 codereview 的意義,也同時發現 codereview 的效率問題 寫這篇文章,希望本文中的一些建議能夠緩解上述問題,能使新人更快的了解 codereview 的意義和方法,有經驗的人能夠...