iT邦幫忙

鐵人檔案

2024 iThome 鐵人賽
回列表
IT 管理

30天從版控到code review的實踐指南 系列

隨著系統開發專案的規模逐漸擴大,協作的工程師人數也相應增加,使程式碼的管理成為專案負責人的一項重要任務。從程式碼的撰寫風格,到版本控管規範,再到Code Review的原則,每一個流程都至關重要。良好的程式碼管理不僅提高專案開發效率,還能確保程式碼的可讀性與可維護性,減少潛在錯誤發生。

在這30天的實踐指南中,將詳細介紹如何規劃和管理每一個環節。希望這系列文章能提供實際的幫助,無論是在個人專案還是團隊合作中,讓程式碼管理更有條理、效率更高。

鐵人鍊成 | 共 30 篇文章 | 6 人訂閱 訂閱系列文 RSS系列文
DAY 21

Day 21. Code Review 程式碼風格-實作範例篇

今天提供幾個針對程式碼風格的人工 Code Review 實作範例,也是Prettier 和 ESLint 比較難檢查到的。 範例 1. 原始程式碼: fun...

2024-10-05 ‧ 由 mcshao 分享
DAY 22

Day 22. Code Review 可維護性與易讀性:註解撰寫規則篇

為什麼需要寫註解? 雖然理想中的 Clean Code 應該具備自我解釋的能力,但實際在開發過程中,撰寫註解仍然是必要的,特別是在協作開發和專案交接的情況中。...

2024-10-06 ‧ 由 mcshao 分享
DAY 23

Day 23. Code Review 可維護性與易讀性:Better Comments 輔助工具篇

今天要介紹 VSCode 中,可讓註解更清楚的輔助 extension- Better Comments。 如何使用 Better Comments 提高程式碼...

2024-10-07 ‧ 由 mcshao 分享
DAY 24

Day 24. Code Review 可維護性與易讀性:Todo Tree 輔助工具篇

今天要介紹 VSCode 中,可讓註解更清楚的輔助 extension- Todo Tree。 如何使用 Todo Tree 提高程式碼易讀性? Todo...

2024-10-08 ‧ 由 mcshao 分享
DAY 25

Day 25. Code Review 安全性原則:XSS 篇

在整個前端開發過程中,包括 JavaScript, HTML, CSS 以及與後端的交互作用,安全性的考量在各個層面都至關重要。以下將針對不同語言在程式碼安全性...

2024-10-09 ‧ 由 mcshao 分享
DAY 26

Day 26. Code Review 安全性原則:CSRF、其他篇

避免 Cross Site Request Forgery(CSRF) CSRF 是一種網絡攻擊,攻擊者會在使用者已經登入的情況下,執行未授權的操作。攻擊者利...

2024-10-10 ‧ 由 mcshao 分享
DAY 27

Day 27. Code Review 模組化與重用性-規則篇。

在 Code Review 時,為了維持程式碼可維護性、易擴充原則,Function 的模組化與重用性為重要原則。今天將介紹撰寫程式碼時,開發人員需遵守的撰寫原...

2024-10-11 ‧ 由 mcshao 分享
DAY 28

Day 28. Code Review 模組化與重用性-範例篇-1。

今天將繼上一篇提到的原則,實際挑選專案中幾個範例給大家參考。 範例 1 :功能模組化。 多次出現的 DataTable 初始化邏輯,可以考慮進行模組化或提高重用...

2024-10-12 ‧ 由 mcshao 分享
DAY 29

Day 29. Code Review 模組化與重用性-範例篇-2

在 Day 1. 的規劃,今天主題是零星補充這個實踐系列的內容,那就繼續延續上一篇,來探討所謂測試覆蓋率高的程式碼,可能會長怎麼樣呢? 範例 3:高測試覆蓋率。...

2024-10-13 ‧ 由 mcshao 分享
DAY 30

Day 30. 如何從無到有,實踐 Code Review-系列文回顧與心得

雖然標題說要回顧,其實有點懶得回顧內容,因為每天寫真的好膩 🤣,但還是不敢相信自己堅持了三十天,我們就先不討論內容的精緻度了,以30天來說,已經超過科學上養成習...

2024-10-14 ‧ 由 mcshao 分享