Java 注释来自接口(interface)或父类(super class)的函数

标签 java javadoc

在尝试遵守正确的 Java 文档注释实践时,在编写扩展基类或实现接口(interface)的类时,如何为已在接口(interface)规范或基类中注释的函数提供注释类(class)?我是否只是简单地从基类或接口(interface)复制并粘贴注释?这种方法似乎违反直觉。

最佳答案

更好用@inheritDoc而不是在界面中手动复制评论。

如果方法的用户可能感兴趣,我会不时地描述实现的细节。但是如果你问我不写评论也没关系。

关于Java 注释来自接口(interface)或父类(super class)的函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/37948694/

相关文章:

java - 如何在java中正确格式化日期

java - 你好,java中的Permute方法

java - OpenJDK 在 processWorkerExit 上中断,没有断点

java - 为什么此 JPA 查询中未使用转换器?

java - 始终在给定树中生成所有 javadoc 的通用 javadoc 命令?

使用 Lombok 的 @Builder 注释时出现 Javadoc "cannot find symbol"错误

java - String.chars() 和 String.codePoints() 上的 javadoc 不正确吗?

java - 编写最新的或兼容的代码是更好的做法吗?

java - 添加元信息是否足以将我自己作为类(class)的附加@作者?

java - Vim:不要对 package.html 中的 Javadoc 或代码片段进行拼写检查