需要区分在接口方法注释和方法实现的注释.

前两天负责review 一些代码, 这些代码的质量都是非常好的, 而且注释也非常的清晰. 不过发现一个问题,  在一个接口的实现类中, 其方法的注释也详细的说明该方法的功能和注意事项. 由于没有看到接口的源文件, 所以不知道该方法对应的接口的注释是怎么杨的. 反正有一个感觉: 这样的注释并不是那么完美的.

通常来说, 我们暴露的都是接口文档, 对于接口中的方法都给于详细的注释描述. 如果在接口方法的实现上也给于同样的注释, 可能会导致一个同步的问题. 我们经常说代码不要沉余, 其实就是为了保证不出现代码不同步的问题.

但是该实现特有的一些信息就还是可以添加到注释中的. 比如具体实现算法等.