程序员代码注释规范

网站建设知识 phpacg 2年前 (2018-04-24) 94次浏览 0个评论

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

我想到的,罕见的状况有:

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

随意的,四处都是注释,有用没用的都写,比如:

  a = 1; // 给 a 赋值为1

谁还看不懂 a=1 是做啥么…

2. 注释不维护

业务变化比拟快的系统,需求时断时续的开发,你要不时对它做维护性质的开发,有时分要不时的修正代码以顺应业务的变化。这时分红绩就来了。。

比如某个函数一末尾是做A这件事,第一团体为这个函数写了注释是A,后来业务变化,第二团体把这个函数改成做B这件事了,然后测试经过,没效果了。此时注释还是A. 后来第三团体改成了做C,注释依然是A。

函数的功用可测,但是注释不可测,注释需求人的维护,假设不维护简直就是噩梦。

假定有第四团体过去读代码,看到注释都是A的内容,他是不是会一头雾水呢?

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

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

3. 代码只注释,不删除

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

喜欢 (0)
发表我的评论
取消评论
表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址