iT邦幫忙

鐵人檔案

2022 iThome 鐵人賽
回列表
Modern Web

那些年我們一起 review 的 code 系列

彙整兩年來 code review 的精華

參賽天數 9 天 | 共 9 篇文章 | 8 人訂閱 訂閱系列文 RSS系列文 團隊我可能不會完賽
DAY 1

那些年我們一起 review 的 code

從團隊開始 code review 後一直沒有好好整理大家決議後的 pattern,趁這次鐵人賽的機會來整理一下這兩年來的 code review 項目,主要針...

2022-09-16 ‧ 由 KK 分享
DAY 2

那些年我們一起 review 的 code:通用規範

為了幫助新人更快速入手 code base,針對變數、函式、檔案、資料夾等名稱與位置都有相對應的規範,以下規範僅適用於我們團隊之中,並非業界標準,如有不同之處請...

2022-09-17 ‧ 由 KK 分享
DAY 3

那些年我們一起 review 的 code:函式規範

關於函式,除了前一個章節講到的動詞開頭外,針對參數設計、命名也有相對應的規範,避免有大量不知其所以然的參數,導致開發受到阻礙。 參數名稱 在我們的應用中,會有兩...

2022-09-18 ‧ 由 KK 分享
DAY 4

那些年我們一起 review 的 code:import 與 export

說到檔案互相引用,我們也有相對應的規範,除了撰寫上要避免 circular import 外,對於命名與位置也有要求。 不共用 export default 跟...

2022-09-19 ‧ 由 KK 分享
DAY 5

那些年我們一起 review 的 code:團隊協作

前面說了許多關於程式碼相關的規範,其實在團隊協作中也有許多要注意的地方,像是 git commit message、PR 的發送方式等等。 git branch...

2022-09-20 ‧ 由 KK 分享
DAY 6

那些年我們一起 review 的 code:分頁處理

提到分頁,大部分的人會很直覺想到 offset pagination,也就是第幾頁的模式,然而實際上還有另一種分頁處理的方式稱為 cursor paginati...

2022-09-21 ‧ 由 KK 分享
DAY 7

那些年我們一起 review 的 code:多國語系

遇到多國語系最麻煩的無非就是 key 該如何訂定?有些人覺得應該語意化,有些人覺得應該直接按照檔案路徑,在激烈的爭辯後,考量到未來的擴充性,我們最後決定採用檔案...

2022-09-22 ‧ 由 KK 分享
DAY 8

那些年我們一起 review 的 code:錯誤處理

說到錯誤處理就會想到錯誤碼的部分,我們團隊針對錯誤碼的命名進行規範,避免未來錯誤碼增加的時候遇到命名困境。 錯誤碼格式 一般來說,我們可以有兩種命名格式資源優先...

2022-09-23 ‧ 由 KK 分享
DAY 9

那些年我們一起 review 的 code:日期與時間

當處理到日期與時間時,特別要注意的地方就是時區,由於後端資料庫中的時區跟使用者的不一定相同,所以我們統一日期時間的處理方式。 一般來說,日期時間有以下幾種表示方...

2022-09-24 ‧ 由 KK 分享