在接口中添加Javadoc注释并在实现中添加非Javadoc注释是否正确？

当您自动生成注释时,大多数IDE会为实现生成非JavaDoc注释.具体方法不应该有描述吗？

解决方法:

对于仅实现的方法(不是覆盖),确定,为什么不,特别是如果它们是公共的.

如果你有一个压倒一切的情况,并且你要复制任何文本,那么绝对不会.复制是造成差异的绝佳方式.因此,用户可以根据他们是否检查超类型或子类型中的方法,对您的方法有不同的理解.使用@inheritDoc或不提供文档 – IDE将在其Javadoc视图中使用最低的可用文本.

顺便说一句,如果你的重写版本在超类型的文档中添加了东西,那么你可能会遇到麻烦.我在博士期间研究了这个问题,发现如果他们通过超类型调用,一般人们永远不会知道覆盖版本中的额外信息.

解决这个问题是我构建的原型工具的主要特征之一 – 每当你调用一个方法时,你都会看到它的目标或任何可能的重写目标是否包含重要信息(例如,冲突的行为).例如,在调用put on map时,系统会提醒您,如果您的实现是TreeMap,则您的元素需要具有可比性.