jdk版本为jdk8,编码工具统一使用idea
1 配置类文件头注释模版
点击IDEA编译器左上角的“IntelliJ IDEA”按钮,选择“Preferences…”,在弹出窗口中,选择“Editor–>File and Code Templates”,在窗口的右边“Schema”下拉栏选择“Default”,然后点击“Includes”标签,在右边模版栏中填写注释模版。最后点击右下角OK按钮生效
参考内容如下:
/**
* description: TODO
* @date: ${DATE} ${TIME}
* @author: wanjinyu(改为自己的邮箱前缀名)
*/
参考截图如下:
2 配置方法头注释模版
点击IDEA编译器左上角的“IntelliJ IDEA”按钮,选择“Preferences…”,在弹出窗口中,选择“Editor–>Live Templates”,进入方法头注释模版编辑界面
2.1 新建一个template group ,我这里起的名字是 bjhlTemplates
2.2 新建一个live template ,配置详细信息
注意配置这些信息:
Template Text 内容如下:
*
* description: TODO
* @date: $date$ $time$
* @author: wanjinyu(改为自己的邮箱前缀名)
$params$
* @return TODO
*/
注意,第一行是空行
点击“Edit variables”,配置参数,截图如下:
params表达式内容:groovyScript(“def result=’’; def params=”${_1}".replaceAll(’[\\[|\\]|\\s]’, ‘’).split(’,’).toList(); for(i = 0; i < params.size(); i++) {result+=’ * @param ’ + params[i] + ((i < params.size() - 1) ? ‘\n’ : ‘’)}; return result", methodParameters())
右键点击“方法注释”,选择“change context……” ,然后选中“Java”即可
完成后确认ok
3 验证“类文件头注释模版”和“方法头注释模版”是否完成
3.1 新建一个class文件,看class头注释是否生成:
3.2 在该类中任意写一个方法,然后 敲入 /**m + 回车键,看是否生成方法注释(注意,别漏了字母m):
如果2个都ok,说明配置成功
3.3 在该类中任意写一个成员变量,然后 敲入 /** + 回车键(注意,不要加字母m),看是否生成变量注释,这个时候只会生成最基本的注释,符合预期
4 Google Code Style配置
在配置菜单中搜索code style,点选Java,在右侧点Manege配置google code style
google code style的xml文件下载地址: https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
将xml文件导入,然后选中GoogleStyle。
说明:1)在Code Style主菜单项中Right Margin的Wrap on typing需要勾选,并且在Code Style->java->Wrapping and Braces中需要勾选Ensure right margin is not exceeded,这两个勾选之后可以保证代码不会超过右边的边界线
2)在Code style->java->Tabs and Indents中continuation indent需要填写2,这表示当一行超出边界换行时前面的缩进大小
5 save actions配置
在配置菜单中搜索Plugins,在右侧选择Browse repositories,搜索save actions,选择安装
下载该插件之后进入Other settings->save action,勾选截图中的选项,这样Java文件会以google code style的风格自动格式化并且去除无用import包。
可以新建一个文件或者修改一个文件,加几个空格,保存后看格式变没,变了表示设置好了
在类中加入这行代码
private static final String TEST_ONE_HUNDRED =“11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111”;
save之后,看看是不是改成
private static final String TEST_ONE_HUNDRED =
“11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111”;
6. 阿里规约插件(可选)
安装方式参考: https://jingyan.baidu.com/article/75ab0bcb75beced6864db2b1.html
不做强制要求,可以参考规约的建议调整代码