服务与支持 |咨询热线 0931-8733767
  • 金城在线
  • 公司简介
  • 发展历程
  • 企业文化
  • 售后服务
  • 工作机会
  • 联系我们

程序员代码注释规范

来源:发布时间:2017-9-11 8:54:59

        写注释如果方法不对,是比没写还恶劣的行为!


        我想到的,常见的情况有:


        1. 注释不规范或过度注释

        随意的,到处都是注释,有用没用的都写,比如: a = 1; // 给 a 赋值为1谁还看不懂 a=1 是做啥么...


        2. 注释不维护

        业务变化比较快的系统,需要连续不断的开发,你要一直对它做维护性质的开发,有时候要不断的修改代码以适应业务的变化。这时候问题就来了。。

        比如某个函数一开始是做A这件事,第一个人为这个函数写了注释是A,后来业务变化,第二个人把这个函数改成做B这件事了,然后测试通过,没问题了。此时注释还是A. 后来第三个人改成了做C,注释仍然是A。函数的功能可测,但是注释不可测,注释需要人的维护,如果不维护简直就是噩梦。假设有第四个人过来读代码,看到注释都是A的内容,他是不是会一头雾水呢?


        有些注释,有人认为很有用,但我觉得在这种场景下不一定。

比如有人喜欢 @author xxx 在函数或者类的前边标记自己的大名,我就觉得这个做法在多人、业务变化的开发场景下,很鸡肋。通常人家把你的代码改得面目全非了,看作者还是你,今后出了问题,后来人诅咒的是你这个 author 啊....


        3. 代码只注释,不删除

        很多人写代码总有这种习惯,一段代码不用了,注释掉,心里总想着这段代码以后可能还会用。但大多数情况下,过几天就忘了,结果代码里到处都是“注释”,没有一句是有用的。读代码的人也不敢删,一直留着留着。


相关文章
  • 预约专家

    为您提供一对一解决方案
    立即预约
  • 售前咨询

    周一至周五9:00——17:30
    立即咨询
  • 联系方式

    13919049954

    全国7×24小时热线服务
  • 免费报价

    专属专业顾问1对1报价
    免费报价