java - 为被覆盖的方法自动生成自定义 JavaDoc 注释

Question

我正在寻找增强 Java 源代码可读性的方法，并希望将以下 JavaDoc 注释添加到所有被覆盖的方法中

/** Overrides {@link com.org.pkg.MyInterface#myMethod}. */
@Override
protected boolean myMethod() {
    ...
}

当类实现多个接口并覆盖某些类方法时，这将很方便。乍一看并不总是很清楚“什么是什么”。

问题是 - 是否有一些命令行工具或 IDE 插件（IDEA、NetBeans、Eclipse）可以自动执行此操作？

score 3 · Accepted Answer

当您创建方法时，Eclipse 会自动为您生成该注释

默认模板是

/* (non-Javadoc)
 * ${see_to_overridden}
 */

其中 ${see_to_overridden} 变成了@see com.org.pkg.MyInterface#myMethod

您可以在 windows->preferences->java->code style->code templates 中更改模板

要将其添加到现有方法中，只需键入 /* 并在方法上方返回

我不知道无论如何要批量这样做

1 回答 1