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

Question

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

This related question 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

我发现这也很有用。

"Fix doc comment"是一种为方法自动添加JavaDoc的简单有用方法。在Keymap设置中指定一个快捷方式（例如alt + shift + 0），当插入符号位于方法内时命中它，它还会根据您刚刚进行的更改更新当前的JavaDoc，并将插入符号移到JavaDoc中以使事情更容易。

Answer 2

自版本2016.2起，IntelliJ IDEA中没有任何功能可以在您更改其返回类型时为方法添加@return标记。

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

Answer 3

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