在尝试遵守正确的 Java 文档注释实践时,在编写扩展基类或实现接口(interface)的类时,如何为已在接口(interface)规范或基类中注释的函数提供注释类(class)?我是否只是简单地从基类或接口(interface)复制并粘贴注释?这种方法似乎违反直觉。
最佳答案
更好用@inheritDoc而不是在界面中手动复制评论。
如果方法的用户可能感兴趣,我会不时地描述实现的细节。但是如果你问我不写评论也没关系。
关于Java 注释来自接口(interface)或父类(super class)的函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/37948694/