看板 Soft_Job 關於我們 聯絡資訊
聽過說法是 1.寫註解是浪費時間,命名命的好不需要寫 2.寫註解方便維護,而且讀中文一定比讀英文快 自己是常常忽略註解, 不過有空還是會補上, 因為程式都只有我在弄, 但是當大型系統過一陣子在拿出來改時, 就知道不寫註解真的是省小時間花大時間, 像是一堆函式傳幾個變數能跑出什麼, 還是同樣提資料,這2個提出來差在哪? 不寫後面維護的人,就要很辛苦去看裡面, 尤其是交接工作, 大家會寫註解嗎? ----- Sent from JPTT on my Sony H4331. -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 223.136.158.205 (臺灣) ※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1572009158.A.286.html
t64141: 寫必要且有實質功能的註解 10/25 21:16
kira1101: 可以爬文看看 之前有很多討論註解的 10/25 21:20
kira1101: 去年好像問同樣問題的也是你 10/25 21:21
CoNsTaR: 命名和註解互助的,可以兩個都有,例如: 10/25 21:25
CoNsTaR: // This member does not need to be most updated 10/25 21:25
CoNsTaR: int ref_count; 10/25 21:25
CoNsTaR: 就會比單純靠命名還要好: 10/25 21:25
CoNsTaR: int ref_count_cache; 10/25 21:25
IHSAHN: 不寫註解受害的只會是一年後的你 10/25 21:27
CoNsTaR: 有些語言的 IDE 只要把滑鼠放在變數、函數、結構上面就可 10/25 21:29
CoNsTaR: 以看到它的註解,這種保證比純靠命名的好多了 10/25 21:29
judge1226: 推一樓 10/25 21:31
alihue: 認為命名好不需要寫的,大概都只寫小專案吧 10/25 21:51
alihue: 大概沒看過給你開 debug mode 還不知道在做什麼的 code 10/25 21:51
sullivan1982: 我是不寫註解派,只有在一些work around會寫,希望 10/25 22:02
sullivan1982: 將來可以修正 10/25 22:02
joejoe14758: 寫啊 有些商業邏輯你就算能用英文寫出來 別人也不一 10/25 22:05
joejoe14758: 定看的懂 有些工程師英文爛到炸 你還用英文寫 10/25 22:05
benedict76: 我們team規定要加英文annotation,用中文有時候build 10/25 22:10
benedict76: code會有問題! 10/25 22:10
spfy: 當你會問這問題就是要寫 為了你好也為了後人好 10/25 22:17
zo6596001: 上份工作看到String莫名其妙變成Function的神奇寫法 10/25 22:23
zo6596001: 這種特殊用法沒有寫註解後面維護的人很痛苦。 10/25 22:24
bill0205: 只有各種function的註解 裡面除非是核心邏輯 不然不寫 10/25 22:27
legion87: 如果是strong type的程式語言,命名原則和詞彙有定義好 10/25 22:28
legion87: 搭配固定的design pattern,確實可以不太需要註解 10/25 22:28
legion87: 不過在現實生活中我還沒看過這種專案 10/25 22:29
ko27tye: 核心功能會吧 get或set那種靠命名就可以很直觀了 10/25 22:35
xrururururu: 寫註解是為了自己 傻傻的 10/25 22:40
MOONY135: 有時候註解會給予多餘的擾亂 10/25 22:45
loadingN: TODO FIXME 10/25 22:45
hankyan919: 先定義什麼叫命名好 10/25 23:13
viper9709: 推二樓 10/25 23:29
somefatguy: 檔 不能沒有註解 10/25 23:33
v7q4: 註解能拯救3個月後的我…… 10/25 23:43
Bencrie: 我可以想像 2 的人講話捲舌的樣子 XD 10/25 23:44
king22649: 看你想做多久(O 10/25 23:47
flowheart: 這問題本身就是個陷阱,註解不是0或1的選擇 10/25 23:50
CloudyWing: 不會寫註解說我這段在做什麼,但會寫說我為什麼會這 10/25 23:50
chuegou: 不寫只是找自己麻煩而已 10/25 23:53
testPtt: 通常不是英文的問題 而是可以避免深入追程式碼 10/25 23:56
william81615: 不寫註解=拉屎給別人吞還不擦屁股 我是這麼覺得 10/25 23:56
umum29: 寫了的幫助絕對比你想像的多 10/26 00:01
gpctv: 抱歉,我會寫,因為以前的公司class function都要寫註解, 10/26 00:34
gpctv: 不寫無法上版,接著我就習慣了 10/26 00:34
bill0129bill: 要 10/26 00:55
vi000246: 我都註解在自己的筆記本裡 科科 10/26 01:08
hooll111: 註解寫清楚 不要廢話 也不要大量註解程式碼 用版控取代 10/26 02:09
Cavalier: 當然要寫, 命名命的再好也只能告訴你 how, 而不是 why 10/26 02:23
Cavalier: 註解的目的不是解釋程式碼做什麼, 而是為什麼選擇這樣做 10/26 02:24
superpai: 我都寫spec不寫註解 10/26 03:29
senjor: 寫Unit test不要寫註解 10/26 03:35
darkMood: /註解 10/26 04:07
deray: 搜尋 註解 討論到爛了 10/26 06:56
eva19452002: var名稱和func名稱命的好 然後內聚力強 不太需要註解 10/26 07:12
PoloHuang: 我是不寫註解 10/26 07:44
jack0204: 一定寫註解,因為所有人的能力不平均 10/26 08:15
goodga: 人的記憶力有限... 10/26 08:45
NTULioner: 完美的情況不需要 但完美的情況不存在 10/26 08:55
sxy67230: 看情況寫,如果不是必要的就不寫,我很多都只在function 10/26 09:20
sxy67230: 或是class下面簡略寫這個class是幹嘛的,這個function 10/26 09:20
sxy67230: 是幹嘛的,輸入是甚麼輸出是甚麼 10/26 09:20
starburs: Clean Code 這本書裡面註解都能自成一章了 10/26 10:00
starburs: 要不要寫註解不是簡單幾句話可以決定的 10/26 10:01
starburs: https://i.imgur.com/Wez6bMe.jpg 10/26 10:01
qpowjohn: 至少會寫function,內容再怎麼走鐘至少方向不變,如果 10/26 11:29
qpowjohn: 方向變了那怎麼不另外寫一隻function 10/26 11:29
Vick753: 你就想註解寫得好是一門學問 10/26 11:33
lucifiel0121: 寫註解是為了交流,溝通「意圖」。如果是 i++ 註解 10/26 12:10
lucifiel0121: 寫 i 會加1 ,這種不用寫,要寫「為什麼是加1」 10/26 12:10
jason710068: Clean code有教,去多看兩遍 10/26 12:12
shter: 演算法的 function 開頭寫個數學公式註解也還好吧 10/26 12:15
thsyou9527: 我會寫 方便過很久後回頭看 10/26 12:53
eva19452002: 光一個變數命名就可以寫成一本書 10/26 13:56
zased: 註解彌補命名無法顧到的地方 為什麼這裡要做這個 因為什麼 10/26 14:48
zased: 限制 10/26 14:48
eatpupu: 必要才寫,失修的註解比不寫還可怕 10/26 15:21
clamperni: 感覺來了就寫啊 10/26 20:48
ji2my: 程式寫到讓人一眼就看懂就不用寫拉 10/26 22:16
thbw666: 有註解是寫中文的喔? 10/26 22:36
labdog: 以前工作有看過每一行code都會寫中文註解的leader 10/27 00:22
realbout: 一開始會寫 後來不寫 後來寫一點XD 10/27 00:38
KanzakiHAria: 要問幾次 10/27 14:43
bonfferoni: 我的註解用中文寫好拿去google翻成阿拉伯文 給你參考 10/27 22:53
anlick: 你之前在本板發問問過類似的問題 洗文章? 10/28 03:13
shooter555: 原來是洗文 10/28 09:30
abc0922001: 他就單純想洗文 10/28 09:37
asoro: 要 10/28 13:21
DCTmaybe: 他只要被噓太多就會自己把文章刪掉 10/28 16:56
sj1973: 特別複雜的地方要註解, 尤其封包內容. 10/29 16:24