guide:code-review
差異處
這裏顯示兩個版本的差異處。
| 兩邊的前次修訂版前次修改 下次修改 | 前次修改 | ||
| guide:code-review [2022/08/17 12:11] – [What? 要看什麼?] admin_wi1d5ky | guide:code-review [2024/12/22 21:17] (目前版本) – 外部編輯 127.0.0.1 | ||
|---|---|---|---|
| 行 5: | 行 5: | ||
| 1. 程式面: 我們會有一個比較健康的程式碼。 | 1. 程式面: 我們會有一個比較健康的程式碼。 | ||
| 2. 團隊面: 每個成員都能彼此熟悉做的東西以及互相學習的機會。 | 2. 團隊面: 每個成員都能彼此熟悉做的東西以及互相學習的機會。 | ||
| + | |||
| ## What? 要看什麼? | ## What? 要看什麼? | ||
| - | - Understand 看懂 | + | ### Understand 看懂 |
| - 看懂 PR 的實作（怎麼實作，包含所用的套件或語法） | - 看懂 PR 的實作（怎麼實作，包含所用的套件或語法） | ||
| - 若是 Bugfix，要確認 root cause 為何，且是否有解決 | - 若是 Bugfix，要確認 root cause 為何，且是否有解決 | ||
| - | - Functionality 功能 | + | |
| - | - Logic 邏輯 | + | ### Functionality 功能 |
| - | - Readability 可讀性 | + | ### Logic 邏輯 |
| + | ### Readability 可讀性 | ||
| - **命名**：是否夠明確，是否符合團隊規範。 | - **命名**：是否夠明確，是否符合團隊規範。 | ||
| - **註解**：不要寫很多註解，因為**程式碼本身就是很好的註解**。只有在一些比較容易看不懂、或者特別邏輯的地方我們會寫適當的註解，且註解只會描述為何要有這段程式。如果看到一段蠻 “奇特” 寫法的地方卻沒有附上註解，就應該請對方補。 | - **註解**：不要寫很多註解，因為**程式碼本身就是很好的註解**。只有在一些比較容易看不懂、或者特別邏輯的地方我們會寫適當的註解，且註解只會描述為何要有這段程式。如果看到一段蠻 “奇特” 寫法的地方卻沒有附上註解，就應該請對方補。 | ||
| - | - Modularity 模組化： | + | |
| + | |||
| + | ### Modularity 模組化： | ||
| - 模組切分的是否恰當，考量**單一職責原則**，一個元件的職責或目的應該很明確，像是 View 我就是放單純 UI 的東西，Model 就負責處理資料。 | - 模組切分的是否恰當，考量**單一職責原則**，一個元件的職責或目的應該很明確，像是 View 我就是放單純 UI 的東西，Model 就負責處理資料。 | ||
| - Function 的參數是否過多、過長？ 如果是過長那很可能是職責太多太雜，我們應該把這個方法拆分。 | - Function 的參數是否過多、過長？ 如果是過長那很可能是職責太多太雜，我們應該把這個方法拆分。 | ||
guide/code-review.1660709502.txt.gz · 上一次變更: 2024/12/22 21:17 (外部編輯)