如何将JavaDoc设置为在Android Studio或IntelliJ IDEA中更改方法签名时自动更新

Question

有没有办法使JavaDoc更新并添加额外的相应标签，例如当我向以前无效的方法添加返回值时。这样，JavaDoc 将在我们更改代码时更新。

这个相关的问题在6年前就被问到日食，但还没有答案。正如评论中所说的那样，这不是重构名称。

 /**
 * Some explanation about method.
 *
 * @return (I want this tag to be added automatically after I add return type "int" to method)
 */
private int ourMethod() {
    int price = quantity * 5;
    return price;
}

Answer 1

我发现这也很有用。

"修复文档注释"是为方法自动添加JavaDoc的简单有用方法。在键盘映射设置中分配一个快捷方式（例如 alt+shift+0），并在插入符号位于方法内部时点击它，它还会根据您刚刚所做的更改更新当前的 JavaDoc，并在 JavaDoc 中移动插入符号以使事情变得更容易。

Answer 2

从版本 2016.2 开始，IntelliJ IDEA 中没有任何功能会在更改方法返回类型时为方法添加@return标记。

对于参数，

如果使用"更改签名"重构，它将为新参数添加@param标记，为删除的参数删除标记，并为重命名的参数更新标记。重命名重构还将重命名@param标记。

Answer 3

据我所知，没有自动方法可以通过更改其方法来添加JavaDoc。但是，您可以通过在方法顶部开始键入/**并按 Enter 来执行此操作。然后自动插入参数和返回值。