最近中秋假期,想必大家都玩的非常愉快,就在大家 happy 的這幾天期間,Google 公開了兩個文檔,我感覺作為程序員和工程師的你們非常有必要了解一下。
這兩份文檔是谷歌的工程實踐文檔。而且文檔的内容都是跟 code review 相關的内容,裡面包含了 Google 工程師如何進行 code view 的内容,以及 code view 指南。
第一份文檔是:
The CL author’s guide to getting through code review
簡單來講就是CL 作者指南去指導通過代碼審查。那麼 CL 是什麼意思呢?就是 change list ,變更記錄和日志的意思。
這個指南可幫助您更快地完成代碼審核并獲得更高質量的結果。适用于每個Google開發人員,閱讀這份指南非常有幫助。
裡面包含了三篇文章:
- 寫出好的 CL 描述
- Small CLs,小的,簡單的 CL ,為什麼需要寫簡單的,小的 CL 呢?裡面文章中給出了具體的答案(比如可以 review 的更快,更直接,如果被拒絕,減少浪費的工作,可以減少引入的 bug 等等)。
- 如何處理 reviewer 者的評論?
文檔地址:https://Google.github.io/eng-practices/review/developer/
第二份文檔:
How to do a code review
這個不用翻譯了,就是如何去做 code review 。
這份文檔中包含有關進行代碼審查的最佳方式的建議。是一個非常完整的文檔,分為許多單獨的部分。閱讀這個文檔,對于大家來看,肯定會非常有幫助,絕對讓大家受益匪淺的一件事。
裡面包含了 6 篇文章,分别是:
- 代碼審查标準
- 在代碼審查中需要注意什麼
- 在審查中導航CL
- 代碼評論速度
- 如何編寫代碼審查評論
- 處理代碼審查中的回退(pushback)
文檔地址:https://Google.github.io/eng-practices/review/reviewer/
每篇文章中的内容寫的都非常的好,非常的全面,包含了為什麼這麼做,如何做的内容,非常值得大家一讀。
看完這兩份文檔,大家肯定就能了解到 Google 的工程師是如何做 code review 的了。這不,你看,國際性大廠的經驗離我們其實也不遠嘛。
唯一的缺點就是文檔是英文的,需要大家自行想辦法去閱讀和翻譯,不過如果你慢慢去閱讀和學習的話,可能不僅僅提高了自己的技術,還提高了自己的英文,何樂而不為呢?
關注公衆号:非著名程序員,對話框回複關鍵字 “1024”,免費領取獨立開發者賺錢案例分享,助力程序員實現财務自由。
,