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

Question

我在我的Java项目中使用Eclipse IDE.

我有一个问题.我的项目中的方法有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中.

Answer 1

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

• 该更改方法签名重构操作还修改的javadoc(添加/删除必要的标记).您应该使用这个或重命名来修改已在使用的代码.
• 如果在Preferences/Java/Editor/Typing页面上激活Add Javadoc标记,则Eclipse 在方法之前键入+ 后会生成正确的javadoc存根./**Enter

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

Answer 2

按下Atl+Shift+R并更改