代码中常见不规范注释介绍
发布人：管理员 发布时间：2015-1-24
代码中的注释能够很有效的帮助我们划分代码中各部分的重要作用,对于代码修改有着重要的意义,但这样的好方法却被很多人用的不仅起不到注释的作用,反而使代码更乱了。下面我们就看看这些不规范的行为。
1. 注释不维护
业务变化比较快的系统,需要连续不断的开发,你要一直对它做维护性质的开发,有时候要不断的修改代码以适应业务的变化。这时候问题就来了。。
比如某个函数一开始是做A这件事,第一个人为这个函数写了注释是A,后来业务变化,第二个人把这个函数改成做B这件事了,然后测试通过,没问题了。此时注释还是A. 后来第三个人改成了做C,注释仍然是A。
函数的功能可测,但是注释不可测,注释需要人的维护,如果不维护简直就是噩梦。
假设有第四个人过来读代码,看到注释都是A的内容,他是不是会一头雾水呢?
有些注释,有人认为很有用,但我觉得在这种场景下不一定。
比如有人喜欢 @author xxx 在函数或者类的前边标记自己的大名,我就觉得这个做法在多人、业务变化的开发场景下,很鸡肋。通常人家把你的代码改得面目全非了,看作者还是你,今后出了问题,后来人诅咒的是你这个 author 啊....
2. 代码只注释,不删除
很多人写代码总有这种习惯,一段代码不用了,注释掉,心里总想着这段代码以后可能还会用。但大多数情况下,过几天就忘了,结果代码里到处都是“注释”,没有一句是有用的。读代码的人也不敢删,一直留着留着。
