作者aoksc (重出江湖)
看板Soft_Job
标题Re: [讨论] 要不要写注解
时间Sat Oct 26 21:39:33 2019
当然是要写
但不是每个method都写
你说的内容感觉比较像summary
summary当然是必写
你就稍微写个一行10~20个字这个method干麻的
也花不到两分钟吧
帮别人也避免自己太久没看忘记了不是很好吗?
某些走火入魔的人就是拿1的观点坚持不写summary
你只要写了就批评你没观念
但实际情况是很多时候根本不是靠命名就能完整说明
尤其是一堆人的英文又很破
我自己是真的很简单的method不会写
像是GetUserInfo这种一看就看出来的字义
而且程式码只有不到十行的话我可能就不会写
但如果包含了商业逻辑而且程式码比较长的话我就会写
还有另外一种就是程式里面的注解
也是一样会有抱持着1观点的北X
坚持要写注解就是你程式写的太复杂要重构重写bala~bala
我认同少写注解
但不是完全不写
因为有时候你的程式可能就是因为某些原因不得不这样写
或者是因为某些讨论之後加了某些程式码
你不写的话後面的人根本不晓得为啥流程突然会冒出这段
如果你把它收敛成method的话那就是前面讲的summary
花个两分钟加个注解
後续维护的人感谢你甚至未来的你也会感谢你
这样不是很好吗？
※ 引述《sec5566 (sec)》之铭言：
: 听过说法是
: 1.写注解是浪费时间，命名命的好不需要写
: 2.写注解方便维护，而且读中文一定比读英文快
: 自己是常常忽略注解，
: 不过有空还是会补上，
: 因为程式都只有我在弄，
: 但是当大型系统过一阵子在拿出来改时，
: 就知道不写注解真的是省小时间花大时间，
: 像是一堆函式传几个变数能跑出什麽，
: 还是同样提资料，这2个提出来差在哪？
: 不写後面维护的人，就要很辛苦去看里面，
: 尤其是交接工作，
: 大家会写注解吗？
: -----
: Sent from JPTT on my Sony H4331.
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 150.117.240.188 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1572097176.A.EE3.html
1F：推 npkalala: 精辟推！！ 10/26 22:23
2F：推 senjor: 个人觉得注解就写成一般引用外部Lib的时候会看见的那种 10/27 02:46
3F：→ senjor: 内容就刚刚好了 10/27 02:46
4F：推 Ghamu: 注解不该重复描写程式码的内容 类似 ”如果怎样就怎麽样” 10/27 03:30
5F：→ Ghamu: 因为注解可能不会被更新 程式码会 要写除了程式码本身以外 10/27 03:30
6F：→ Ghamu: 的意图 才不会不匹配被误导 10/27 03:30
7F：推 viper9709: 推同感 10/27 23:09
8F：→ cat0429: 其实不写注解有个很重要的原因：英文太破写不出来 10/28 09:16
9F：推 lucky4283: 推这篇，写注解不是很基本的常识吗.... 10/30 19:56
10F：推 as885212: 在现实世界如果只会二分法 真的是蛮好笑的 10/31 16:02