java - 我们应该使用 JavaDoc 类扩展抽象类吗?

标签 java javadoc

假设我正在编写一个扩展抽象类“Work”的类“MyWork”。现在,假设我在“MyWork”中需要的所有方法都已经声明,并且已经在“Work”中编写了它们的 JavaDoc。我还应该在“MyWork”中添加 JavaDoc 吗?

干杯!

最佳答案

这取决于。如果您没有覆盖任何方法,则没有添加 Javadoc 的选项(仅在类级别)。向类中添加一些 Javadoc 来解释它存在的原因可能是有意义的。

如果要覆盖方法,可以这样编写 Javadoc:

/**
 * {@inheritDoc}
 * This implementation also does...
 */

关于java - 我们应该使用 JavaDoc 类扩展抽象类吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/15588791/

相关文章:

java - Eclipse 不再自动在 javadocs 中添加标签

Javadoc doclet : Get "@Nullable" annotation (javax). 如何在 doclet 中获取该注释?

maven - 如何在 Kotlin 代码上强制执行完整的文档

java - 拆分字符串、对其进行平面映射并使用 Java 流创建对象?

objective-c - 如何通过 CodeSense 在 Xcode 中显示文档?

Java 比较泛型和 Void

java - 如何创建一个空的 java.util.UUID 对象?

java - 如何从调用者处检索以编程方式调用的 Javadoc doclet 的输出?

java - log4j2 设置 Async Logger 和 Async Appender 的线程数

java - 如何正确添加和删除 JList 选定值