※ 引述《sec5566 (sec)》之铭言:
: 听过说法是
: 1.写注解是浪费时间,命名命的好不需要写
讲到这个我就想浮出来,
写程式写了也快20年了吧?
我真的不知道什么叫做命名命的好不需要写注解,
会觉得自己命名很棒而不需要写注解,
是很自大的想法,
更多是用来偷懒当不想写注解的理由,
实在搞不懂为什么有人连花个5分钟写注解都不愿意,
结果他放假,别人看不懂他的code,只能call他时,就要搞一小时,
程式100行以上就该写,至少写一下这个程式在干什么的,
如果是两个人以上一起写,也要写一下那一部份是谁写的
还有另一种状况,
就是注解就变成用来内斗的工具,
故意批对方注解写得少,写得看不懂要重写,
然后硬凹说对方程式没写完,
结果自己注解写得更少或更烂,
或是整个组识走向极端搞得每行都写
注解没有说一定要写多少,
以自己,和同事能看得懂为准,
所以难理解的地方就要多写,
同事功力不强的话,就要多写,
(不是说越强的人越不用写,因为要"互相配合",
而弱者要花更多时间了解你的code,
花一大堆时间教弱者,不如干脆多写注解来让每个弱者来都能自己搞懂)
这种事和吃饭一样,饭一定要吃,不吃会饿死,
要吃是以能吃到不饿为原则,
每个人饿的标准也不同,食量也不同,
但不用搞到吃到很撑,吃太撑也会死掉,
偏偏很多人就很极端
: 2.写注解方便维护,而且读中文一定比读英文快
: 自己是常常忽略注解,
: 不过有空还是会补上,
: 因为程式都只有我在弄,
: 但是当大型系统过一阵子在拿出来改时,
: 就知道不写注解真的是省小时间花大时间,
: 像是一堆函式传几个变量能跑出什么,
: 还是同样提资料,这2个提出来差在哪?
: 不写后面维护的人,就要很辛苦去看里面,
: 尤其是交接工作,
: 大家会写注解吗?
: