IDEA设置代码规范,代码格式化设置

  1. 下载IDEA的eclipse的Formatter插件

安装插件  settings --->plugins--->

Adapter for eclipse Code Formatter

(alibaba java coding Gulidelines  一款基于阿里巴巴Java开发手册的IDEA插件,它提供了一系列的代码检查和自动修复功能,帮助开发者遵循阿里巴巴的Java编码规范。https://blog.csdn.net/dongdong199033/article/details/129675836)

下载添加之后,重启IDEA

2. 下载codestyle.xml文件

网址: GitHub - alibaba/p3c: Alibaba Java Coding Guidelines pmd implements and IDE plugin

截图:

3. 导入并设置codestyle.xml

4.测试

快捷键 ctrl+alt+L

根据阿里的代码格式对我们的项目进行代码格式化

5. 新建Java类的头部注释

内容: 两个空格



/**
 * @className
${NAME}
 * @description ${description}
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @version v1.0
**/

File—>settings—>Editor—>File and Code Templates—>Files—>Class

6. 接口注释模版配置

File—>settings—>Editor—>File and Code Templates—>Files—>Interface

内容:





/**

 * @interfaceName ${NAME}

 * @description ${description} 

 * @author ${USER}

 * @date ${DATE} ${TIME}

 * @version v1.0

**/

7. 枚举注释模版配置

File—>settings—>Editor—>File and Code Templates—>Files—>Enum

内容:





/**

 * @enumName ${NAME}

 * @description ${description} 

 * @author ${USER}

 * @date ${DATE} ${TIME}

 * @version v1.0

**/

8. method的头部注释

File-->Settings-->Editor-->Live Templates

点击右边上面那个的+号,选择Template Group,弹出一个窗口,添加一个分组名字(可自己命名),我这里添加的是method,然后点击OK

**

 * @description 

$param$ 

 * @return $return$

 * @author wl

 * @date $date$ $time$

 */

设置应用场景:点击模版下方的警告,来设置应用于那些场景

点击Edit Template  Variables配置模板参数,设置完成后保存

阿里idea代码格式化指的是使用阿里巴巴开发的IDEA插件Alibaba Java Coding Guidelines来对Java代码进行格式化规范化。 Alibaba Java Coding Guidelines致力于提供Java代码规范和最佳实践,帮助开发人员编写高质量的Java代码。它可以自动检测代码中的潜在问题,并提供相应的修复建议。 使用Alibaba Java Coding Guidelines插件进行代码格式化可以带来以下好处: 1. 遵循统一的代码规范:该插件基于阿里巴巴Java开发手册,可以强制开发团队遵循统一的代码规范,提高代码的可读性和可维护性。 2. 快速修复代码问题:该插件可以自动检测代码中可能存在的问题,例如潜在的Bug、代码冗余、不安全的编码实践等,并给出相应的修复建议。这有助于开发人员及时发现和解决潜在的代码问题。 3. 减少代码审查时间:代码格式化可以使代码风格统一,减少代码审查时因为个人编码风格的不同而产生的争议。团队成员可以专注于代码质量和功能设计方面的审查,提高审查效率。 4. 提高代码可读性:代码格式化可以使代码结构清晰、易于理解,增强了代码的可读性。这对于团队协作、项目维护和代码重构非常有帮助。 总之,阿里idea代码格式化是通过使用Alibaba Java Coding Guidelines插件来规范和优化Java代码的一种方式,可以帮助开发人员编写高质量的代码,提高团队协作效率和项目质量。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值