如何在 Eclipse 中更改方法签名时自动更新 Javadoc?

2022-09-01 16:08:36

我正在使用Eclipse IDE进行Java项目。

我有一个问题。我的项目中有一些方法,这些方法具有javadoc注释,如下所示:

/**
 * Retruns the string representation of a input stream
 * @param in
 * @return
 * @throws IOException
 */
public static String getStringFromInputStream (InputStream in) throws IOException {
    StringBuffer out = new StringBuffer();
    byte[] b = new byte[4096];
    for (int n; (n = in.read(b)) != -1;) {
        out.append(new String(b, 0, n));
    }
    return out.toString();
}

现在我想知道,每当我对方法的签名进行更改时,这些更改会自动反映在javadoc中。


答案 1

Eclipse提供了相当不错的选项来确保javadoc的正确性,除了上面提到的重命名重构JesperE:

  • 更改方法签名重构操作还会修改 javadoc(添加/删除必要的标记)。您应该使用这个或重命名来修改已经在使用的代码。
  • 如果您在首选项/Java/编辑器/键入页面上激活了添加Javadoc标签,那么Eclipse会在方法之前键入+后生成正确的javadoc存根。/**Enter

您还可以设置编译器选项来检查首选项/Java/编译器/Javadoc 上缺少的 javadoc 标记。在这种情况下,您会收到编译器关于丢失/额外标记的警告,并且您有快速修复()来修复它们。从长远来看,这是确保现有javadocs的正确性的一个不错的选择。Ctrl+1


答案 2

我不知道有什么方法可以自动同步Javadoc头,但是如果你使用+重命名参数,Javadoc头就会被适当地重命名。Ctrl-1Rename in file


推荐