关于代码注释

关于代码注释

很多人不喜欢写注释，包括我在内，有的人是命名好，所以不需要加注释。大部分人可不都是高手。

每次看代码时，遇到陌生的方法、参数、属性时，总是去看实体、数据库，结合着看，就怕意思理解错了。

这就是一个典型的问题，有的实体英文命名挺容易懂，而有的就不容易懂。我们列一张表格做个对比。

1直接字面意思能看懂的属性：

看懂属性------花费1秒

2看不懂的属性+属性旁边有注释：

看注释，再结合属性的名字，匹配一下------花费3秒钟时间

3看不懂的属性+没有注释：假设你数据库查询已经打开了

敲SQL语句：花费3秒

点击查询、拖动滚动条看字段，花费5秒

如果这时看懂了好说，看不懂的话，继续！

查看页面：花费10秒，看不懂的话，继续！

查看代码：花费30秒以上

4加上注释：

打上注释：3到5秒

日后维护注释：3到5秒

5一个数据：一段代码，有70%的时间是在维护！

换人维护代码是一件稀松平常的事情。

总结：哪个速度快，哪个速度慢，一目了然！

一个字段是这样，如果每天你碰到10个到20个这样的属性，估计要崩溃了。