回看板
Disp BBS
作者 wei115 (社畜)
標題 Re: [閒聊] 寫code不加註解真的很顧人怨嗎
時間 Fri Dec 27 14:14:10 2024

還好八

反正註釋這種東西，也太詳細也沒人看
最多就函式功能、輸入輸出寫寫
然後複雜的演算法寫寫


我覺得程式寫的清楚比較重要

原廠給我的code，每個模組都用一堆全域變數
單獨跑可能還好，要讓兩個模組一起跑就各種奇怪的問題
測試也不全面
開發到一半，發現硬體動不起來
拿示波器測波形也沒出來
最後邊看code 邊看手冊 才發現他時鐘樹設錯 要自己除PLL頻率改參數





本來以為這已經很誇張了
但我同事會寫這樣的code

有個需求是調整倍率 然後調整之後 要在畫面上顯示一段時間消失
1、1.5、2、2.5、3這樣

通常來說可能就是
label、設定倍率(倍率)、timer(秒) 這樣的組合
先用設定倍率(倍率)設定label的值，然後設個timer多久隱藏

然後他這樣寫
label[0]
label[1]
label[2]
label[3]
label[4]

timer0
timer1
timer2
timer3
timer4

每個label都是固定文字，選到哪個就用對應的定時器顯示N秒後消失
https://i.imgur.com/CLs8LGE.png
[圖]


相比之下 我覺得註釋根本就可有可無

--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 220.134.21.189 (臺灣)
※ 作者: wei115 2024-12-27 14:14:10
※ 文章代碼(AID): #1dRaMrEW (C_Chat)
※ 文章網址: https://www.ptt.cc/bbs/C_Chat/M.1735280053.A.3A0.html
※ 同主題文章:
Re: [閒聊] 寫code不加註解真的很顧人怨嗎
12-25 19:42 SkankHunt42
Re: [閒聊] 寫code不加註解真的很顧人怨嗎
12-25 22:55 k12s35h813g
Re: [閒聊] 寫code不加註解真的很顧人怨嗎
12-27 14:14 wei115
推 strlen: 這才是實務經驗 註解根本不可信 浪費時間1F 12/27 14:23
推 shirleyEchi: 你都說完了還有什麼問題2F 12/27 14:23
推 hoyunxian: 反正最後編譯起來都會變成沒有意義的文字(?)3F 12/27 14:42
噓 multiView: 實務經驗個屁啊，過猶不及。4F 12/27 14:53
推 h0103661: 還好吧，這樣寫到時候改成別的訊息很方便啊5F 12/27 15:04
→ episode666: 當註解寫Dont remove 或Dont modify配上一個十年前的日期以及一個不在的人命，敢改就看你八字夠不夠重6F 12/27 15:04
推 kirimaru73: 這個寫法就是實務上可行，但我前公司的code review只要看的人用0.5就可以讓對方飛到天花板上
當然你們如果沒有這樣的code review那我也沒差
能讓人飛到天花板的理由很簡單，你現在知道要求是1/1.5/2/2.5/3倍，那你身為一個合格的員工應該要想像到以後會有0.25/1.75等需求，在沒有特別要求的情況下就應該自動刻出一個generalize的功能
老實說這理由很見正大光明，我看到誰被電的話也只會笑他活該，但你們公司如果不想這樣電人也不是不行8F 12/27 15:34

--
作者 wei115 的最新發文:
點此顯示更多發文記錄