楼主:
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特别复杂的地方要注解, 尤其封包内容.