Java 注释来自接口或超类的函数
Java commenting a function from interface or superclass
在尝试遵守正确的 Java 文档评论实践时，在编写扩展基础 class 或实现接口的 class 时，我如何提供评论已在接口规范或基础 class 中注释的函数？我是否只是从基础 class 或界面复制并粘贴评论？这种方法似乎违反直觉。
最好使用 @inheritDoc 而不是在界面中手动复制评论。
如果方法的用户可能感兴趣，我会不时地描述实现的细节。但是如果你问我不写评论也可以。
切勿复制和粘贴评论。否则，在修改任何内容时，很难同时准确地更新所有这些内容。复制注释可能比复制代码更糟糕，因为如果有任何不一致，编译器将不会注意到。
class 中方法的注释应该记录该方法的作用，而不是其基础 classes 或正在实现的接口中覆盖的方法正在做什么，绝不是什么派生的 classes 中的方法可能正在做。
最重要的是：不要评论不需要评论的东西。参数类型等明显的东西将由 Javadoc 自动生成。
Javadoc默认继承parent描述，如果没有指定其他的，如果你决定重写javadoc是因为在这种情况下implementation/override这样的方法是important/different 它 "deserves" 它自己的 javadoc。
如果你想保留两者，我通常做的是通过将它添加到本地 "element" (class/method) 来覆盖 javadoc，然后添加一个 @see 引用它parent "element"
在尝试遵守正确的 Java 文档评论实践时，在编写扩展基础 class 或实现接口的 class 时，我如何提供评论已在接口规范或基础 class 中注释的函数？我是否只是从基础 class 或界面复制并粘贴评论？这种方法似乎违反直觉。
最好使用 @inheritDoc 而不是在界面中手动复制评论。
如果方法的用户可能感兴趣，我会不时地描述实现的细节。但是如果你问我不写评论也可以。
切勿复制和粘贴评论。否则，在修改任何内容时，很难同时准确地更新所有这些内容。复制注释可能比复制代码更糟糕，因为如果有任何不一致，编译器将不会注意到。
class 中方法的注释应该记录该方法的作用，而不是其基础 classes 或正在实现的接口中覆盖的方法正在做什么，绝不是什么派生的 classes 中的方法可能正在做。
最重要的是：不要评论不需要评论的东西。参数类型等明显的东西将由 Javadoc 自动生成。
Javadoc默认继承parent描述，如果没有指定其他的，如果你决定重写javadoc是因为在这种情况下implementation/override这样的方法是important/different 它 "deserves" 它自己的 javadoc。
如果你想保留两者，我通常做的是通过将它添加到本地 "element" (class/method) 来覆盖 javadoc，然后添加一个 @see 引用它parent "element"