作者:
sec5566 (sec)
2019-10-25 21:12:36聽過說法是
1.寫註解是浪費時間，命名命的好不需要寫
2.寫註解方便維護，而且讀中文一定比讀英文快
自己是常常忽略註解，
不過有空還是會補上，
因為程式都只有我在弄，
但是當大型系統過一陣子在拿出來改時，
就知道不寫註解真的是省小時間花大時間，
像是一堆函式傳幾個變數能跑出什麼，
還是同樣提資料，這2個提出來差在哪？
不寫後面維護的人，就要很辛苦去看裡面，
尤其是交接工作，
大家會寫註解嗎？
作者: t64141 (榕樹) 2019-10-25 21:16:00
寫必要且有實質功能的註解
作者: kira1101 (肉包) 2019-10-25 21:20:00
可以爬文看看 之前有很多討論註解的去年好像問同樣問題的也是你
作者:
CoNsTaR ((const *))
2019-10-25 21:25:00命名和註解互助的，可以兩個都有，例如：// This member does not need to be most updatedint ref_count;就會比單純靠命名還要好：int ref_count_cache;
作者:
IHSAHN (...)
2019-10-25 21:27:00不寫註解受害的只會是一年後的你
作者:
CoNsTaR ((const *))
2019-10-25 21:29:00有些語言的 IDE 只要把滑鼠放在變數、函數、結構上面就可以看到它的註解，這種保證比純靠命名的好多了
作者:
alihue (wanda wanda)
2019-10-25 21:51:00認為命名好不需要寫的，大概都只寫小專案吧大概沒看過給你開 debug mode 還不知道在做什麼的 code
我是不寫註解派，只有在一些work around會寫，希望將來可以修正
寫啊 有些商業邏輯你就算能用英文寫出來 別人也不一定看的懂 有些工程師英文爛到炸 你還用英文寫
我們team規定要加英文annotation，用中文有時候buildcode會有問題!
作者:
spfy (spfy)
2019-10-25 22:17:00當你會問這問題就是要寫 為了你好也為了後人好
上份工作看到String莫名其妙變成Function的神奇寫法這種特殊用法沒有寫註解後面維護的人很痛苦。
作者:
bill0205 (善良的小孩沒人愛)
2019-10-25 22:27:00只有各種function的註解 裡面除非是核心邏輯 不然不寫
如果是strong type的程式語言，命名原則和詞彙有定義好搭配固定的design pattern，確實可以不太需要註解不過在現實生活中我還沒看過這種專案
作者:
ko27tye (好滋好滋)
2019-10-25 22:35:00核心功能會吧 get或set那種靠命名就可以很直觀了
作者:
loadingN (sarsaparilla)
2019-10-25 22:45:00TODO FIXME
作者: somefatguy 2019-10-25 23:33:00
檔 不能沒有註解
作者:
v7q4 ((．)(．)乳劍雙修 -|＝＞)
2019-10-25 23:43:00註解能拯救3個月後的我……
作者:
chuegou (chuegou)
2019-10-25 23:53:00不寫只是找自己麻煩而已
作者:
testPtt (測試)
2019-10-25 23:56:00通常不是英文的問題 而是可以避免深入追程式碼
作者:
umum29 (....)
2019-10-26 00:01:00寫了的幫助絕對比你想像的多
作者:
gpctv (gpctv)
2019-10-26 00:34:00抱歉，我會寫，因為以前的公司class function都要寫註解，不寫無法上版，接著我就習慣了
作者:
hooll111 (Katsudon)
2019-10-26 02:09:00註解寫清楚 不要廢話 也不要大量註解程式碼 用版控取代
作者: Cavalier (Cavalier) 2019-10-26 02:23:00
當然要寫, 命名命的再好也只能告訴你 how, 而不是 why註解的目的不是解釋程式碼做什麼, 而是為什麼選擇這樣做
作者:
senjor (哞哞)
2019-10-26 03:35:00寫Unit test不要寫註解
作者:
deray (Deray)
2019-10-26 06:56:00搜尋 註解 討論到爛了
var名稱和func名稱命的好 然後內聚力強 不太需要註解
作者: PoloHuang (黃保羅) 2019-10-26 07:44:00
我是不寫註解
作者:
jack0204 (Jarbar王朝)
2019-10-26 08:15:00一定寫註解，因為所有人的能力不平均
作者:
goodga ( )
2019-10-26 08:45:00人的記憶力有限...
作者:
NTULioner (LionsHeart)
2019-10-26 08:55:00完美的情況不需要 但完美的情況不存在
作者:
sxy67230 (charlesgg)
2019-10-26 09:20:00看情況寫，如果不是必要的就不寫，我很多都只在function或是class下面簡略寫這個class是幹嘛的，這個function是幹嘛的，輸入是甚麼輸出是甚麼
至少會寫function，內容再怎麼走鐘至少方向不變，如果方向變了那怎麼不另外寫一隻function
作者:
Vick753 (彬彬)
2019-10-26 11:33:00你就想註解寫得好是一門學問
作者: lucifiel0121 (Ashe) 2019-10-26 12:10:00
寫註解是為了交流，溝通「意圖」。如果是 i++ 註解寫 i 會加1 ，這種不用寫，要寫「為什麼是加1」
作者:
shter (飛梭之影)
2019-10-26 12:15:00演算法的 function 開頭寫個數學公式註解也還好吧
作者:
zased (我只是上PTT查資料)
2019-10-26 14:48:00註解彌補命名無法顧到的地方 為什麼這裡要做這個 因為什麼限制
作者: eatpupu (吃大便) 2019-10-26 15:21:00
必要才寫，失修的註解比不寫還可怕
作者:
ji2my (hkt)
2019-10-26 22:16:00程式寫到讓人一眼就看懂就不用寫拉
作者:
thbw666 (富和尚)
2019-10-26 22:36:00有註解是寫中文的喔?
作者:
labdog (飛啊,飛啊, 小飛俠)
2019-10-27 00:22:00以前工作有看過每一行code都會寫中文註解的leader
我的註解用中文寫好拿去google翻成阿拉伯文 給你參考
作者:
anlick (小野)
2019-10-28 03:13:00你之前在本板發問問過類似的問題 洗文章?
作者:
asoro (asoro)
2019-10-28 13:21:00要
作者:
sj1973 (史考特)
2019-10-29 16:24:00特別複雜的地方要註解, 尤其封包內容.