[C 的那些眉角]註解要寫「為什麼」,不是「做什麼」

記得很久以前,我寫註解的方式大概類似這樣:

i++;  // i 加 1

現在想起來,覺得很好笑。
當時覺得「有寫註解」這件事本身就是好習慣,
至於寫了什麼⋯⋯好像不太重要?

後來進公司,第一次被 senior 在 code review 上留言:
「這個註解跟沒寫一樣。」

很直接,但他說得對。

閱讀全文