代码注释一定要有，并且不能脱离业务

最近新负责了一个新的领域模块。将项目从SVN导入IDE后，打开代码一看，唯一的中文就是方法中的魔法值。。。

原来负责的人离职了，文档当时也没写。接口什么的都是口口相传。

痛苦

其实随着公司的发展，业务的变更。很多代码都面临着被重构的情况。那些对修改关闭，对拓展开放的设计准则并不是每个人都能够掌握的。

如果是职场新人，一定要写注释。不然会被老人各种喷。

从读代码的角度讲，注释又分一下几种：

类注释：

进入类后会先看类注释。目的是查看这个类在业务中起的作用。

如果是需要寻找的类，就会进入看方法注释

字段注释：

简单的字段一目了然，有些结合业务的字段。可能会有特殊的格式，可能会有特殊的含义，一定要描述出来

方法注释：

一个好的方法命名可以描述出方法的功效。但别人读的时候还是希望能看到方法在类中起的业务作用。

还有参数和返回一定要加上注释，虽然有些时候你会觉得这个参数大家都知道。但不排除有不了解业务的人来读代码。

而且如果有个注释，一是在寻找某个方法时能够快速的阅览；二是在使用IDE调用方法时也能给与对应的提示。

方法内的 ：

一些特殊的算法一定要写。如果行注释不够就写块注释。

某些方法会耦合很多的业务逻辑，尽量能把这些逻辑描述一下，一是给不知道这些逻辑的人看，二是等上一两个月自己看的时候能够最快的找到需要找的。