新版本 IDEA 支持设置保存时的动作,在 Preferences
下的 Tools | Actions on Save
中:
actions on save
支持如下动作:
官方文档:https://www.jetbrains.com/help/idea/saving-and-reverting-changes.html#actions-on-save
JavaDoc 插件,可以用来根据方法名、参数名等信息,在代码中自动添加或移除 JavaDoc 注释。
安装插件之后,可通过右键 Generate...
功能调出生成或移除 JavaDoc 的菜单点击使用,或直接使用对应快捷键操作:
generate
可生成或移除选定元素的 JavaDoc,也可对文件中所有元素,乃至整个目录(在目录右键选择 JavaDoc 对应菜单,慎用)进行操作。
插件默认的配置在生成 JavaDoc 时会对已有的 JavaDoc 内容进行保留,不会覆盖掉手写的 JavaDoc 内容,只会补充缺失的部分。
以 StringUtil.java[10] 为例,生成的 JavaDoc 内容如下:
@@ -4,6 +4,9 @@ import org.apache.commons.lang3.StringUtils;
import java.util.Locale;
+/**
+ * The type String util.
+ */
public class StringUtil extends StringUtils {
/**
@@ -12,6 +15,12 @@ public class StringUtil extends StringUtils {
private StringUtil() {
}
+ /**
+ * Camel to snake string.
+ *
+ * @param camel the camel
+ * @return the string
+ */
public static String camelToSnake(String camel) {
String[] strings = StringUtil.splitByCharacterTypeCamelCase(camel);
return StringUtil.join(strings, "_").toLowerCase(Locale.ENGLISH);
插件配置界面,支持进行基本配置及模板配置,可对生成的 JavaDoc 内容进行定制,详细可见 Javadoc-templates[11]:
general
templates
IDEA 里默认的注释方式是在行首添加双斜线,如:
public static String camelToSnake(String camel) {
// String[] strings = StringUtil.splitByCharacterTypeCamelCase(camel);
return StringUtil.join(strings, "_").toLowerCase(Locale.ENGLISH);
}
想调整为添加到首字符前,可双击 Shift
键,输入 line comment at first column
,调整对应语言的配置,如下图:
line comment
取消 Line comment at first column
后,再选中 Add a space at line comment start
,可得到如下风格的注释缩进:
public static String camelToSnake(String camel) {
// String[] strings = StringUtil.splitByCharacterTypeCamelCase(camel);
return StringUtil.join(strings, "_").toLowerCase(Locale.ENGLISH);
}