🎯 什麼情境該想到我
當你「發現自己在寫一大堆註釋,去解釋一段本身就難懂的程式碼」的時候——註釋在替壞碼擦脂抹粉。
⚙️ 怎麼用(步驟 / 公式)
這味道是什麼徵兆:註釋本身是好東西,但常被當成「除臭劑」——因為碼寫得糟,才需要註釋來解釋。作者的建議:當你想寫註釋時,先試著重構,讓碼好到不需要那條註釋。
通常用哪些重構手法對治:
- 提煉函式(Extract Function):把「需要註釋說明的那段」抽成一個以該註釋為名的函式,讓名字取代註釋。
- 改變函式宣告(Change Function Declaration)/改名:用更誠實的名字,讓意圖寫在名字裡。
- 若註釋在陳述前置條件,考慮**引入斷言(Introduce Assertion)**用程式碼表達。
留下的註釋,應該說「為什麼這樣做」,而不是「這段在做什麼」。
🧪 我實際套用的紀錄
- (待填)
⚠️ 注意 / 什麼時候不適用
- 註釋不是壞事:解釋「為什麼」、記錄取捨與陷阱、標示尚不確定之處的註釋都很有價值。
- 別因為這條味道就把所有註釋刪光;先把碼改到自解釋,再保留真正必要的說明。
🔗 相關工具
- 神秘命名 Mysterious Name(好名字能取代大量解釋性註釋)
- 過長函式 Long Function(區塊註釋常是「該提煉函式」的提示)
- 重構