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

[strlen (strlen)]

※ 引述《ianlin1216 (伊恩可可)》之銘言：
: 實務上遇到這種情況真的很賭爛嗎
: 乾五西恰

最好的作法是
盡量把程式寫得清楚簡單易懂好理解
這樣就不需要加註解了

註解是拿來用在解釋特殊情況
也就是
當某段程式你怎麼樣也沒辦法直接用程式碼解釋
這時候你再去下註解
所以理想狀況是
註解應該要非常少甚至完全沒有（小一點的系統

理由很簡單
註解也是要維護
很多人修bug都忙死了
哪來美國時間跟你改註解？
不然就忘東忘西
這邊修一下那邊調一下
協作時可能還不只一個人在改同個地方
時間一久註解就忘了更新
過時的註解比沒有註解還要來得糟糕
因為反而會誤導別人
然後整個團隊太多人被註解騙惹
越來越不信任註解
最後就乾脆整個無視
但又不曉得該不該刪掉
久了就變成技術債
礙眼的垃圾
但你又不敢動它...............

至於
怎麼把程式寫得清楚簡單易懂
這就是功力問題
呵

--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 118.169.33.144 (臺灣)
※ 文章網址: https://www.ptt.cc/bbs/C_Chat/M.1735131102.A.A4E.html
推 ren740719: 就很多人自己為自己寫得清楚簡單易懂，殊不知下個接手
→ ren740719: 專案的，看到只想問候前任的老目
所以要code review
所以要pair programming
所以別悶著頭寫自己的要和人蕉流蕉流
才不會變成自嗨

→ Wardyal: 我看Clean Code也是推薦註解越少越好
※ 編輯: strlen (118.169.33.144 臺灣), 12/25/2024 21:00:32
推 jeff666: 我有自知之明寫得很爛 乖乖寫註解
推 ssarc: 就是上備註嘛，不管做什麼工作都需要上備註，有些備註好有
→ ssarc: 些備註爛
推 XFarter: https://www.reddit.com/r/learnprogramming/s/ivot6CreK
→ XFarter: P
→ XFarter: 只能說做法各有千秋 但很多細部行為只靠著變數名稱去解釋
→ XFarter: 其實蠻困難的
現在有AI
何不問問萬能的ChatGPT你這東東該怎摸命名
※ 編輯: strlen (118.169.33.144 臺灣), 12/25/2024 21:05:37
→ spfy: Clean Code寫的和實做差很多阿 人月神話一堆人看過 但業界
→ spfy: 還不是用隕石開發法+10個媽媽懷胎1個月
→ spfy: 但也是有任天堂這種做的比教科書好還自己開發工具的奇蹟
→ spfy: 我現在會用AI測試幫我加註解和重新命名 如果它給的建議很爛
→ spfy: 表示你扣寫的很爛他沒辦法判斷 這還滿有用的
推 shadow0326: 我還知道要TDD 要測試即文件 要持續整合 要安全左移呢
推 orze04: 公司鎖ChatGpt
公司有提供其它AI工具可用嗎？
沒有
請趕快逃了啦
跟不上時代的廢物

推 v86861062: 對ㄚ
※ 編輯: strlen (118.169.33.144 臺灣), 12/25/2024 23:23:10
推 sowulo: 我也覺得命名比註解還重要 註解只有在命名無法解釋時用
推 rockmanx52: 記得有個經典註解是「我他X根本不知道寫這段鬼東西有
→ rockmanx52: 什麼意義 但刪了它這該死的玩意兒就不會動」
推 EXTECH: 老闆要求特殊邏輯1，客戶要求特殊邏輯2
推 ppn: 真的 封AI的公司還是快逃無誤 只會被歷史的車輪輾死