idea配置阿里格式化模板+注释模板
文章目录
- 1 背景
- 1.1 开发工具
- 1.2 代码格式化模板
- 1.3 注释模板
- 2 下载模板文件
- 3 IDEA代码格式化
- 3.2 配置代码格式
- 3.3 使用
- 4 IDEA代码注释配置
- 4.1 配置全局中USER
- 4.2 配置类注释模板
- 4.3 配置方法注释
- 4.3.1 配置流程
- 4.3.2 配置参数
- 4.3.3 使用
- 4.3.2 注意事项
- 4.4 补充(关于类注释)
- 4.4.1 配置流程
- 4.4.2 配置参数
- 4.4.3 使用
1 背景
本文意在将idea中的代码格式
和注释格式
进行统一化。
研发团队的成员的代码格式和注释格式建议统一化
。
统一的代码格式
和注释格式
,能给代码阅读上带来极大的便利,给代码改动上提高极大的效率。
1.1 开发工具
idea
1.2 代码格式化模板
阿里格式化模板
1.3 注释模板
(1)类模板样例
/*** (自定义类描述)* @author zhangsan* @date 2020/09/08 08:23**/
public class MyTest {}
(2)方法模板样例
/*** (自定义方法描述)* @author zhangsan* @date 2020/09/07 20:07* @param message * @param name * @return java.lang.String */
public String myTest(String message,String name){return "";
}
无参方法,将不生成@param
参数:
/*** (自定义方法描述)* @author zhangsan* @date 2020/09/08 08:02* @return java.lang.String */
public String myTest(){return "";
}
2 下载模板文件
阿里模板下载地址
https://github.com/alibaba/p3c/tree/master/p3c-formatter
下载如下两个模板文件(链接为下载页面):
代码格式(用于代码格式化
):eclipse-codestyle.xml
代码模板(代码注释模板
,IDEA中无法使用
):eclipse-codetemplate.xml
3 IDEA代码格式化
因阿里提供的代码格式化配置是基于eclipse
的,如需在idea
中使用此配置,需要安装对应的eclipse插件
。
3.1 安装插件
阿里配置文件是针对ecplice
的,在IDE
中,所有的配置文件导入,需要安装Eclipse Code Formatter
插件。
3.2 配置代码格式
File
->Settings
->Other Settings
->Eclipse Code Formatter
进行idea代码格式配置:
将代码格式化文件eclipse-codestyle.xml
,配置到插件中:
3.3 使用
(1)格式化部分代码
选中需要格式化的
代码,快捷键:ctrl+alt+L
(2)格式化整个文件
在需要格式化的文件中,快捷键:ctrl+alt+L
(3)格式化整个项目(慎用)
idea中,项目上右键
->Reformat Code
如已经存在的项目初次使用统一的代码格式化,建议在一个时间点将整个项目统一进行一次代码格式化。避免单独的格式化,导致部分研发人员的代码合并出现严重冲突。
4 IDEA代码注释配置
4.1 配置全局中USER
在此配置全局USER,用于填充自动生成的注释中的作者
@author属性。
Help
->Edit Custom VM Options...
增加如下配置:
-Duser.name=xxx
4.2 配置类注释模板
settings
->Editor
->File and Code Templates
->files
->class
增加注释模板:
/*** ${description}* @author ${USER}* @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}**/
模板增加后,如下(注释上方的换行符必须有
):
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")/*** ${description}* @author ${USER}* @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}**/
public class ${NAME} {}
新创建java文件时,会提示输入类描述description
,生成的文件格式如下:
package com.test;/*** 我的测试类* @author zhangsan* @date 2020/09/08 10:23**/
public class MyTest {}
4.3 配置方法注释
4.3.1 配置流程
Editor
->Live Template
->java
新建Live Template,进行如下配置:
第5步,适用场景配置如下:
第6步,模板变量配置如下:
4.3.2 配置参数
(1)模板配置
配置如下:
缩写Abbreviation:
*
模板Template text:
** * @author $user$* @date $data$ $time$$param$* @return $return$ */
(2)变量配置
user:
user()
date:
date("yyyy/MM/dd")
time:
time("HH:mm")
param:
groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {result+='\\n' + ' * @param ' + params[i] + ' '}; return result;}", methodParameters());
return:
methodReturnType()
4.3.3 使用
在java方法上输入/**
后,按下tab
键,即可在方法上方生成方法注释
,如下:
/*** (①方法描述)* @author zhangsan* @date 2020/09/07 20:07* @param message (②参数描述)* @param name (②参数描述)* @return java.lang.String (③返回值描述)*/
public String myTest(String message,String name){return "";
}
依次填写:
①方法描述
②参数描述
③返回值描述
4.3.2 注意事项
(1)为避免对变量注释时的影响,变量的注释仍然采用默认的注释方式:/**
+回车
,生成的注释仍然是默认注释:
/*** */
private String userName;
(2)无参方法,将不生成@param
参数:
/*** * @author zhangsan* @date 2020/09/08 08:02* @return java.lang.String */
public String myTest(){return "";
}
4.4 补充(关于类注释)
4.2中,配置的类注释模板,需要在创建类
的时候,才可以生成类注释
。对于拷贝过来的类文件,或者已经存在的类文件,无法加上对应注释。
因此,可以参照4.3
,进行代码模板配置。
4.4.1 配置流程
其中的5 适用场景
同4.3.1:
4.4.2 配置参数
(1)模板配置
配置如下:
缩写Abbreviation:
cc
模板Template text:
/*** * @author $user$* @date $date$ $time$**/
(2)变量配置
user:
user()
date:
date("yyyy/MM/dd")
time:
time("HH:mm")
description:
不配置
4.4.3 使用
在类上
输入cc
后,按下回车
键,即可在方法上方生成类注释
,如下:
/*** (①类描述)* @author zhangsan* @date 2020/09/08 08:21**/
public class MyTest {}
填写:
①类描述
idea配置阿里格式化模板+注释模板相关推荐
- Myeclipse学习总结(3)——Myeclipse中的代码格式化、注释模板及保存时自动格式化
设置Myeclipse中的代码格式化.注释模板及保存时自动格式化 1:设置注释的模板: 下载此模板: codetemplates.xml
- IDEA必备插件、阿里巴巴规范插件(代码格式化,注释模板化)的安装及使用和快捷键设置
背景:记录下idea的配置,换电脑方便直接配置这些信息 第一步:安装必备插件如下 英文直接翻译就是插件的作用,大部分不用额外配置,Adapter for Eclipse Code Formatter是 ...
- Idea注释模板以及插件基础配置
Idea注释模板以及插件基础配置 一.idea注释模板 (1)类注释模板 (2)方法注释模板 二.idea插件配置 (1)Alibaba Java Coding Guidelines(阿里开发规范) ...
- IntelliJ IDEA类和方法注释模板配置
1.设置文件注释 设置Java类的注释模板,创建Java类自动生成该注释模板. 先看文件注释效果: 1.1.选择 IntelliJ IDEA -> 选择 Preferences... 打开IDE ...
- eclipse注释模板与格式化模板
不管是注释模板还是格式化模板,都是让我们的代码有一个统一的规范,可以方便程序员阅读,提高代码的可读性,对于代码后期维护提供了巨大的帮助. 一.注释模板 一般我们在开发过程中固定注释表现为对文件.类.方 ...
- IDEA 这样配置注释模板,让你高出一个逼格
欢迎关注方志朋的博客,回复"666"获面试宝典 一.类注释 打开 IDEA 的 Settings,点击 Editor-->File and Code Templates,点击 ...
- idea新建类模板注释设置_开发者必备——IDEA配置清单
本文主要探讨主流开发工具Intellj IDEA的常用配置及部分插件,供读者参考. 1,常用配置 1.1 配置JDK 1.2 配置自动导包 1.3 配置Maven(内嵌) 配置阿里云镜像加速 Sett ...
- 开发规范-java代码注释及IDEA配置代码注释模板
引(阿里巴巴开发规范-注释规约) [强制]类.类属性.类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用 // xxx 方式. 说明:在 IDE 编辑窗口中,Javadoc 方式 ...
- IDEA这样配置注释模板,让你高出一个逼格!!
作者: Jitwxs 链接: https://jitwxs.cn/4135e0a9.html 一.类注释 打开 IDEA 的 Settings,点击 Editor-->File and Co ...
- Eclipse/MyEclipse注释模板和格式化模板的使用
2019独角兽企业重金招聘Python工程师标准>>> 在一个项目的完整的生命周期中,其维护费用,往往是其开发费用的数倍.因此项目的可维护性.可复用性是衡量一个项目好坏的关键.而注释 ...
最新文章
- Chrome v28 会在pwd目录下生成libpeerconnection.log文件
- 修改机器名、IP对arcgis server、portal的影响?
- SQL DMV功能使用
- c++ double float 数值比较
- 小白入门深度学习 | 第四篇:配置PyTorch环境
- CListCtrl的使用完全指南
- 解决ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)
- 通过nginx链接mysql事务问题_nginx-关于phpmysql的事务
- 最受欢迎的应用服务器
- 设计灵感合集|拟人化创意合成小动物,治愈可爱风插画作品
- 深入理解jQuery中的Deferred
- 白话使用zookeeper作为注册中心搭建微服务
- 如何选择tomcat版本
- 收评:5月24日资金流向(摘自益盟)
- java jxl.jar_jxl.jar官方下载-jxl.jar(java操作excel) 免费版 - 河东下载站
- 目标检测 | 火焰烟雾检测论文(实验部分)
- 曙光服务器S640-G30配置管理口图文教程(完整版)
- MSSQL2019+Linux7, The SQLServerAgent is not currently running, so it cannot be notified of this
- 大数据学习路线,如何学习大数据?
- 智能编程和乐高机器人的区别
热门文章
- 基于ATmega16单片机 程控滤波器程序源代码
- DSP2812/28335 调试问题记录
- 工频变压器和高频变压器
- 全国计算机等级二级ACCESS数据库程序设计(更新完毕)
- GPS卫星星历与卫星历书的区别
- 算法介绍及实现——基于遗传算法改进的BP神经网络算法(附完整Python实现)
- 中国31省R&D经费支出、R&D投入强度数据(2000-2018年)
- 移植conda环境到另一台服务器上
- AI技术的苹果iPhone XS Max双卡双待7纳米6.5寸512GB顶配12799元(公号回复“苹果AI”下载PDF资料)
- 如何判断对方列表里是不是好友_QQ怎么知道自己是不是对方好友