2015061507 - 注释说明

   注释一般是对代码的说明和补充,如果代码能说明问题可以不添加注释,但是存在一个问题就是你认为表达的很清楚了,也许事实上真是表达很清楚.但是对于别人而言,未必能认为你的代码能表达很清楚.所以若干注释是必要的.

   对于特定的业务,首批开发者对业务都比较熟悉,从技术开发角度而言可能对他来说很简单很容易,几句话的事情.

对于中途接手的继任者而言,从业务的不熟悉不了解到逐渐了解,难度不是从无到有的按照自己思路的开发,而是在现有代码基础上阅读并且继续开发.

   如果没有详细设计说明书,而纯粹看现有代码来了解.有接触UFO的感触.对从中途接手开发到维护者而言,dao和service接口的注释说明都是十二分必要的,因为它们替代了详细设计说明书的作用!

   类的注释,除了记录作者和开发时间,需要添加类的用途.而现有类上只是添加作者和时间.如果作者还在可以咨询若干,如果不在,那么注释等于垃圾注释.类的用途要比作者和时间更有使用价值.

   方法,常见的用途可以不必写注释(现有代码注释比较少),说明方法用途,以及有特别注意事项,比如参数的注意事项,实现的特殊思路,以及为什么要这么去做.参数的含义基本都没有阐述.

   如果都存在,方法调用者和后期代码维护者一定非常开心.

   我深刻的感觉,对于后来的维护者而言,前任的最好给予就是足够的有用的注释!不写注释的开发者注定会被别人在他背后骂他的!