[譯] 代碼審查之最佳實踐
https://mp.weixin.qq.com/s/p_CNasQxzdni4G2eD0xUrQ
審查者應該注意的清單：
一、意圖
1.代碼是否達成了作者的意圖？
2.問問題。
二、實現
1.想想如果換成你會怎樣解決問題。
2.你看到了潛在的可用抽象嗎？
3.以對手的角色思考，以友善的態度待人。
4.考慮一下庫或既有的產品代碼。
5.代碼的更改是否遵循了標準的模式？
6.所做更改是否增加了編譯時或運行時的依賴（特別是在子項目中）？
三、易讀性和樣式
1.考慮你的閱讀體驗。
2.代碼是否遵從了編碼規範？
3.代碼中是否還有 TODOs ？
四、可維護性
1.讀一讀測試。
2.本次測試是否引入了新的風險？
3.本次改變是否破壞了向後相容？
4.這塊代碼需要集成測試嗎？
5.代碼注釋，以及 commit message。
6.外部文檔是否更新了？
五、安全性
核實 API 端與代碼庫中其他部分保持一致，執行了適當的認證和鑒權。
六、注釋：簡明、友好、可行
審查者的注釋 應該簡明，並且用人話寫。評論代碼，而不是用作者的口氣。 當有些問題不甚清楚時，詢問後弄清楚好過假設那就是愚蠢的。避免人物之間的比較，帶上評價就更不好。
#code review, 代碼審查
https://mp.weixin.qq.com/s/p_CNasQxzdni4G2eD0xUrQ
審查者應該注意的清單：
一、意圖
1.代碼是否達成了作者的意圖？
2.問問題。
二、實現
1.想想如果換成你會怎樣解決問題。
2.你看到了潛在的可用抽象嗎？
3.以對手的角色思考，以友善的態度待人。
4.考慮一下庫或既有的產品代碼。
5.代碼的更改是否遵循了標準的模式？
6.所做更改是否增加了編譯時或運行時的依賴（特別是在子項目中）？
三、易讀性和樣式
1.考慮你的閱讀體驗。
2.代碼是否遵從了編碼規範？
3.代碼中是否還有 TODOs ？
四、可維護性
1.讀一讀測試。
2.本次測試是否引入了新的風險？
3.本次改變是否破壞了向後相容？
4.這塊代碼需要集成測試嗎？
5.代碼注釋，以及 commit message。
6.外部文檔是否更新了？
五、安全性
核實 API 端與代碼庫中其他部分保持一致，執行了適當的認證和鑒權。
六、注釋：簡明、友好、可行
審查者的注釋 應該簡明，並且用人話寫。評論代碼，而不是用作者的口氣。 當有些問題不甚清楚時，詢問後弄清楚好過假設那就是愚蠢的。避免人物之間的比較，帶上評價就更不好。
#code review, 代碼審查
留言
張貼留言