这个问题讨论很多次了
先讲一下写注解最可能的缺点好了
第一 程式码与注解不同步
也就是当程式码更新的时候
注解没有更新
第二 多了许多噪声
如果注解没写好的话
反而是个干扰阅读的东西
那不写注解又有什么缺点
第一 对于功能没有说明都需要由程式码来了解
所以可能必须花更长的时间来理解
第二 特例的状况绝对会感到莫名奇妙
譬如老板说王董的帐号给他特权
莫名奇妙就多个if user xxx then xxx
抓不著头绪
所以该不该写注解就是看当下场景做选择了
程式码能够表达明确的意图
也就是程式码本身就能够提供良好的说明
那当然可以不用写
如果逻辑十分复杂
程式码很难表达意图
那该写的还是要写
再来就是特例几乎都要写
写了程式码回过头看自己程式码
摸摸良心认为别人不需要注解也能看的懂的话
那就不用写了
如果自己不能判断别人有没有办法看懂
那还是乖乖补上别害人了
※ 引述《sec5566 (sec)》之铭言：
: 听过说法是
: 1.写注解是浪费时间，命名命的好不需要写
: 2.写注解方便维护，而且读中文一定比读英文快
: 自己是常常忽略注解，
: 不过有空还是会补上，
: 因为程式都只有我在弄，
: 但是当大型系统过一阵子在拿出来改时，
: 就知道不写注解真的是省小时间花大时间，
: 像是一堆函式传几个变量能跑出什么，
: 还是同样提资料，这2个提出来差在哪？
: 不写后面维护的人，就要很辛苦去看里面，
: 尤其是交接工作，
: 大家会写注解吗？
: