当我在 Android Studio 或 IntelliJ IDEA 中更改方法签名时,如何设置 JavaDoc 自动更新
How to set JavaDoc to update automatically when I change the method signature in Android Studio or IntelliJ IDEA
有没有办法让 JavaDoc 更新并添加额外的相应标签,例如,当我将 return 值添加到之前无效的方法时。这样,JavaDoc 将在我们更改代码时更新。
This related question 6 年前询问过 eclipse,但目前还没有答案。正如评论中所说,这与重构名称无关。
/**
* 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;
}
从版本 2016.2 开始,IntelliJ IDEA 中没有任何功能可以在您更改其 return 类型时为方法添加 @return
标记。
对于参数,如果您使用 "Change signature" 重构,它将为新参数添加 @param
标记,为您删除的参数删除它们,并为您重命名的参数更新它们。重命名重构还将重命名 @param
个标签。
我发现这也很有用。
"Fix doc comment" 是一种为方法自动添加 JavaDoc 的简单有用的方法。在 Keymap 设置中分配一个快捷方式(例如 alt+shift+0)并在插入符号位于方法内部时点击它,它还会根据您刚刚所做的更改更新当前的 JavaDoc 并将插入符号移动到 JavaDoc 中以使事情变得更容易.
据我所知,没有通过更改其方法来添加 JavaDoc 的自动方法。但是,您可以通过在方法顶部开始键入 /**
并按回车键来完成。然后会自动插入参数以及 return。
有没有办法让 JavaDoc 更新并添加额外的相应标签,例如,当我将 return 值添加到之前无效的方法时。这样,JavaDoc 将在我们更改代码时更新。
This related question 6 年前询问过 eclipse,但目前还没有答案。正如评论中所说,这与重构名称无关。
/**
* 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;
}
从版本 2016.2 开始,IntelliJ IDEA 中没有任何功能可以在您更改其 return 类型时为方法添加 @return
标记。
对于参数,如果您使用 "Change signature" 重构,它将为新参数添加 @param
标记,为您删除的参数删除它们,并为您重命名的参数更新它们。重命名重构还将重命名 @param
个标签。
我发现这也很有用。
"Fix doc comment" 是一种为方法自动添加 JavaDoc 的简单有用的方法。在 Keymap 设置中分配一个快捷方式(例如 alt+shift+0)并在插入符号位于方法内部时点击它,它还会根据您刚刚所做的更改更新当前的 JavaDoc 并将插入符号移动到 JavaDoc 中以使事情变得更容易.
据我所知,没有通过更改其方法来添加 JavaDoc 的自动方法。但是,您可以通过在方法顶部开始键入 /**
并按回车键来完成。然后会自动插入参数以及 return。