🎯 什麼情境該想到我
當你「看到一個函式、變數或欄位的名字,卻得跳進去看實作才知道它到底代表什麼」的時候——名字沒有誠實說出它的用途與意圖。
⚙️ 怎麼用(步驟 / 公式)
這味道是什麼徵兆:命名是程式最基本也最重要的溝通工具。名字取不好,代表你其實還沒真正想清楚這東西的職責;含糊、縮寫、與內容不符的名字會讓後來的人(包含未來的你)不斷誤解與踩雷。
好名字的價值在於「不用看實作就懂」。當你想不到好名字時,往往是背後的設計還沒理清——改名的過程常會逼出更深的問題。
通常用哪些重構手法對治:
- 改變函式宣告(Change Function Declaration):替函式改一個能表達意圖的名字。
- 變數改名(Rename Variable):讓變數名說出它承載的意義。
- 欄位改名(Rename Field):讓資料結構的欄位名反映真實內容。
🧪 我實際套用的紀錄
- (待填)
⚠️ 注意 / 什麼時候不適用
- 別為了「更潮」而改名,改名要讓意圖更清楚,而非只是換個花樣。
- 廣為人知的慣例名(如迴圈的
i、數學公式裡的短名)在小範圍內反而清楚,不必硬展開。 - 改名要連同所有引用一起改,靠工具或編譯器確保沒漏,別留下半新半舊的名字。
🔗 相關工具
- 過長函式 Long Function(拆小以後,每一段更需要一個誠實的名字)
- 註釋 Comments(常是壞名字的補丁;先改名讓碼自解釋,再看還需不需要註釋)
- 重構