Re: [閒聊] 寫code不加註解真的很顧人怨嗎 strlen PTT批踢踢實業坊

Re: [閒聊] 寫code不加註解真的很顧人怨嗎

作者: strlen (strlen) 2024-12-25 20:51:38

※ 引述《ianlin1216 (伊恩可可)》之銘言：
: 實務上遇到這種情況真的很賭爛嗎
: 乾五西恰
最好的作法是
盡量把程式寫得清楚簡單易懂好理解
這樣就不需要加註解了
註解是拿來用在解釋特殊情況
也就是
當某段程式你怎麼樣也沒辦法直接用程式碼解釋
這時候你再去下註解
所以理想狀況是
註解應該要非常少甚至完全沒有（小一點的系統
理由很簡單
註解也是要維護
很多人修bug都忙死了
哪來美國時間跟你改註解？
不然就忘東忘西
這邊修一下那邊調一下
協作時可能還不只一個人在改同個地方
時間一久註解就忘了更新
過時的註解比沒有註解還要來得糟糕
因為反而會誤導別人
然後整個團隊太多人被註解騙惹
越來越不信任註解
最後就乾脆整個無視
但又不曉得該不該刪掉
久了就變成技術債
礙眼的垃圾
但你又不敢動它...............
至於
怎麼把程式寫得清楚簡單易懂
這就是功力問題
呵

作者: ren740719 (雪月燦) 2024-12-25 20:56:00

就很多人自己為自己寫得清楚簡單易懂，殊不知下個接手專案的，看到只想問候前任的老目

作者: Wardyal (Wardyal) 2024-12-25 20:57:00

我看Clean Code也是推薦註解越少越好

作者: jeff666 2024-12-25 21:00:00

我有自知之明寫得很爛乖乖寫註解

作者: ssarc (ftb) 2024-12-25 21:01:00

就是上備註嘛，不管做什麼工作都需要上備註，有些備註好有些備註爛

作者: XFarter (劈哩啪啦碰碰碰) 2024-12-25 21:02:00

https://www.reddit.com/r/learnprogramming/s/ivot6CreKP只能說做法各有千秋但很多細部行為只靠著變數名稱去解釋其實蠻困難的

作者: spfy (spfy) 2024-12-25 21:09:00

Clean Code寫的和實做差很多阿人月神話一堆人看過但業界還不是用隕石開發法+10個媽媽懷胎1個月但也是有任天堂這種做的比教科書好還自己開發工具的奇蹟我現在會用AI測試幫我加註解和重新命名如果它給的建議很爛表示你扣寫的很爛他沒辦法判斷這還滿有用的