idea的代码规范设置

idea的代码规范设置
步骤
1、安装idea的EclipseCodeFormatter插件(代码规范工具)

安装教程:https://www.jianshu.com/p/9befe7710176或者 自行百度搜索依次点击进入插件界面:File->Settings->Plugins,搜索 eclipse code formatter,如已有插件则不需安装,如没有,点击Search in repositories自动搜索线上插件。

【idea的代码规范设置】
2、导入团队的代码规范xml文件,启用规范导入 eclipse-codestyle.xml
依次点击进入插件界面:File->Settings->Other Settings->Eclipse Code Formatter,将阿里的代码规范配置文件eclipse-codestyle.xml 引入配置。


启用阿里的代码规范配置后,可以使用 Clt + Alt + L 格式化选中代码
3、自定义新建class文件时,自动生成类的说明注释
依次点击进入插件界面:File->Settings->Editor->File and Code Templates,添加 File Header 配置。/** * @author ${USER} * @Description TODO * @Date ${DATE} ${TIME} */


4、自定义手动添加类注释、方法注释时,自动生成符合规范的注释代码块

依次点击进入插件界面:File->Settings->Editor->Live Templates,添加 CgmGroup 配置。(代码注释的统一规范要求:类注释、方法名的注释保持一致)/** * @author $USER$ * @Description TODO * @Date $date$ $time$ */

① 添加CgmGroup配置

② 添加类、方法注释
/**添加类、方法注释


③ 配置参数的变量

配置完成后,可以使用 / + Tab 键,即可在类名、方法名上添加对应的注释代码块,若不喜欢 / + Tab 键,可以自己定义对应的生成代码块注释的快捷键
实际的使用效果如下:
package com.sisensing.cgm.medicine.controller.physician; /** * @author qz.wu * @Description TODO * @Date 2021/8/9 17:37 */ public class Test {/** * @author qz.wu * @Description TODO * @Date 2021/8/9 17:38 */ public String getValue(String id, String name) { return ""; } }

eclipse-codestyle.xml
Wrapping And Braces -> Simple classes in one line -->Wrapping And Braces -> Simple method in one line -->Wrapping And Braces -> Simple block in one line -> do not select -->Wrapping And Braces -> try statement -> catch.... (Java:CATCH_ON_NEW_LINE)-->

    推荐阅读