Java从接口或超类注释函数
在尝试遵循适当的Java文档注释实践时，在编写扩展基类或实现接口的类时，如何向已在接口规范或基类中注释的函数提供注释？我是否只是从基类或接口复制并粘贴注释？这种方法似乎违反直觉。最好使用，而不是在界面中手动复制注释 如果方法的用户感兴趣，我会不时地描述实现的细节。但是如果你问我，也可以不写评论。最好在界面中使用而不是手动复制评论Java从接口或超类注释函数,java,javadoc,Java,Javadoc,在尝试遵循适当的Java文档注释实践时，在编写扩展基类或实现接口的类时，如何向已在接口规范或基类中注释的函数提供注释？我是否只是从基类或接口复制并粘贴注释？这种方法似乎违反直觉。最好使用，而不是在界面中手动复制注释 如果方法的用户感兴趣，我会不时地描述实现的细节。但是如果你问我，也可以不写评论。最好在界面中使用而不是手动复制评论 如果方法的用户感兴趣，我会不时地描述实现的细节。但是如果你问我，也可以不写评论。永远不要复制和粘贴评论。否则，在修改任何内容时，很难同时准确地更新所有内容。复制注释可能
如果方法的用户感兴趣，我会不时地描述实现的细节。但是如果你问我，也可以不写评论。永远不要复制和粘贴评论。否则，在修改任何内容时，很难同时准确地更新所有内容。复制注释可能比复制代码更糟糕，因为编译器不会注意到任何不一致的地方 类中方法的注释应该记录该方法的功能，而不是记录其基类或正在实现的接口中被重写的方法的功能，也决不是记录派生类中的方法的功能
最重要的是：不要评论那些不需要评论的东西。参数类型等明显的内容将由Javadoc自动生成。切勿复制和粘贴注释。否则，在修改任何内容时，很难同时准确地更新所有内容。复制注释可能比复制代码更糟糕，因为编译器不会注意到任何不一致的地方 类中方法的注释应该记录该方法的功能，而不是记录其基类或正在实现的接口中被重写的方法的功能，也决不是记录派生类中的方法的功能
最重要的是：不要评论那些不需要评论的东西。参数类型等明显的东西将由Javadoc自动生成。Javadoc默认情况下继承父描述，如果没有指定其他描述，如果您决定覆盖Javadoc，这是因为在这种情况下，这种方法的实现/覆盖非常重要/不同，它应该拥有自己的Javadoc
如果您想同时保留这两个元素，我通常会通过将其添加到本地元素类/方法来覆盖javadoc，然后添加一个@see引用到其父元素，如果没有指定其他元素，则默认情况下javadoc继承父描述，如果您决定重写一个javadoc，这是因为在这种情况下，这种方法的实现/重写非常重要/不同，它应该拥有自己的javadoc 如果您想同时保留这两个元素，我通常会通过将javadoc添加到本地元素类/方法来覆盖它，然后添加一个@see引用到其父元素