程式碼審查很難。以下是一些心得分享。
- 原文出處：https://dev.to/saminarp/today-i-learned-the-subtle-art-of-code-reviews-3pef
我最近在審查 https://github.com/humphd/my-photohub 的一個 PR。
這是我有生以來第一次進行程式碼審查，也讓我知道這項任務有多麼困難。第一次當審閱者，我發現自己盯著程式碼，思考可以做些什麼來讓它更好。感覺相當迷茫。我想出了一些平庸的建議。沒想到什麼厲害的。沒有什麼讓我覺得很滿意的建議。然後是 Dave 教授 https://github.com/humphd 對我正在審查的同一個 PR 進行程式碼審查。我只是坐在那裡，對他看到而我沒看到的細節感到驚訝。他提出了一些大改善，比如更好的程式設計邏輯，以及一些小建議，比如更新專案描述。這些小建議我也可以提出：更好的專案描述、更適合專案的圖示而不是預設的 React 圖示、並為某些事情創建紀錄追蹤。為什麼我會忽略掉 Dave 教授如此優雅、毫不費力就指出的明顯事情？
一些程式碼審查的最佳實踐
這是一篇很棒的文章 https://google.github.io/eng-practices/review/reviewer/looking-for.html 我在研究程式碼審查最佳實踐時找到的。
它漂亮地闡述了設計、功能、複雜性、測試、命名、註釋、樣式、一致性、文檔和上下文都是代碼審查的重要組成。
時間、注意力、溝通
好的審查需要時間和注意力。它需要我們批判性地思考程式設計邏輯。對於初學者來說，盯著別人寫的程式碼來建議一些有意義的東西，可能會讓人感到不知所措。害怕犯錯。害怕冒犯寫程式的人。我知道，因為這些我都有感受到。在開源專案中，在提供建設性回饋的同時，在溝通中保持禮貌和尊重很重要。我們有時可能不認同審查，這種時候，我們應該禮貌地溝通。
在給予和接受回饋時，保持開放的心態也很重要。正是通過這種思想交流和回饋，我們才能夠隨著時間一直進步。
如果你有一些寫程式經驗，只要花足夠的時間專心看程式碼，幾乎總是可以提出改進建議。
從小處著手
如果您是初學者，請從小處著手並向他人學習。閱讀 Dave 教授的評論，我學到了很多重要的東西。然後我意識到，只有看到更有經驗的人如何審查程式碼，我才能變得更好。我記下了我在 GitHub 上閱讀他的大量評論所學到的東西。我把這些東西變成了清單：
如果不清楚，請詢問有關某程式碼的具體問題。
找找看未使用的依賴項和優化 package.json 的方法。
從整個程式碼庫的上下文中來看事情。
留下一些鼓勵的話，指出開發人員做對了什麼！
專注於功能和相容性。
找出清晰的命名和適當的命名約定。
查看 README 檔或 CONTRIBUTING.md 檔時，請看看樣式、格式、拼寫和語法的一致性。
確保設計和UI看起來不錯。
確保單元測試是為這段程式碼適當設計的。
確保程式碼符合提供的某個樣式指南。
linters 會帶給我們信任
程式碼自動檢查器和靜態工具分析器可以幫助審閱者節省大量時間在尋找愚蠢的拼寫錯誤或樣式錯誤。linters 和 sanners 的作用大概就是拼寫和語法檢查。省下了檢查格式和其他風格的麻煩，審閱者可以專注於程式碼的實際邏輯。作為程式碼審閱者，必須使用可用的自動代碼檢查器來節省時間和心思。
關於生產力的最後一點想法
如果你像我一樣喜歡閱讀有關心理學和生產力的文章，這是一篇很棒的文章 https://jamesclear.com/focus#Focus%20on%20the%20Process
1) --- 會變成分隔線（上一行必須是空白）
2) # 會變成一級標題
3) ## 會變成二級標題
4) ### 會變成三級標題
5) **粗體文字**會顯示粗體文字
6) ```當第一行與最後一行會顯示程式碼
7) 請搜尋 Markdown 語法，了解各種格式
