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配置模板参数,设置完成后保存

Logo

腾讯云面向开发者汇聚海量精品云计算使用和开发经验,营造开放的云计算技术生态圈。

更多推荐