IDEA代码规范插件P3C+代码注释模板配置方法
作者:小鹏子的博客 发布时间:2022-10-30 17:32:55
IDEA配置阿里规范插件P3C
进入idea -》File -》 Settings -》Plugins
到搜索框中搜索:Alibaba Java Coding Guidelines
下载安装插件,安装之后重启IDEA ,进入你的编辑器右击会发现多
了,检查规范和关闭检查。
检查会发现你这个java文件是否存在问题并给出提示如:
也常常遇到类是 class 或者方法上面缺少 javadoc注解 如:
所有的类都必须添加创建者信息
所有的抽象方法(包括接口中的方法)必须要用javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。
通过添加java 类 、方法注释模板来满足这些需求
开发工具 :IDEA
代码格式化模板 : 阿里格式化模板
注释模板样例
/**
* 类模板样例
* Demo class (描述)
*
* @author keriezhang
* @date 2016/10/31 20:07
*/
public class CodeNoteDemo {
}
/**
* 方法模板样例
* fetch data by rule id (描述)
*
* @author keriezhang
* @date 2016/10/31 20:07
* @param ruleId rule id
* @param page page number
* @param jsonContext json format context
* @return Result<XxxxDO>
*/
Result<XxxxDO> fetchDataByRuleId(Long ruleId, Integer page, String jsonContext);
IDEA配置模板步骤
配置全局USERHelp->Edit Custom VM Options...
配置全局USER,用于填充自动生成的注释中的作者@author属性。添加一行 -Duser.name=xxx
(xxx为名称)
配置类注释模板 settings->Editor->File and Code Templates->files->class
增加注释模板内容:
/**
* ${description}
* @author ${USER}
* @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
**/
新创建java文件时,会提示输入类描述description,生成的文件格式如下:
package tuan.press.test;
/**
* 测试类
* @author keriezhang
* @date 2016/10/31 20:07
**/
public class MyTests {
}
配置方法注释 Editor->Live Template->java
新建Live Template,进行如下配置:
第5步,适用场景配置如下:
第6步,模板变量配置如下:
配置参数
缩写Abbreviation:
*
模板Template text:
*
*
* @author $user$
* @date $data$ $time$$param$
* @return $return$
*/
变量配置
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()
方法注释使用
在java方法上输入/**后,按下tab键,即可在方法上方生成方法注释,如下:
/**
* (①方法描述)
* @author keriezhang
* @date 2016/05/07 10:07
* @param message (②参数描述)
* @param name (②参数描述)
* @return java.lang.String (③返回值描述)
*/
public String myTest(String message,String name){
return "";
}
来源:https://blog.csdn.net/weixin_44519874/article/details/112259616
猜你喜欢
- 1.alibaba falstjson1.Map转JSONMap<String, Object> map = new HashM
- 1.首先解释一下什么是方法重载?方法重载是指在同一个类中方法同名,参数不同,调用时根据实参的形式,选择与他匹配的方法执行操作的一种技术。这里
- 目录wait-notifyjoin方式ReentrantLockReentrantLock+ConditionSemaphore三个线程T1
- 介绍超级管理员:系统管理、用户管理、网点管理、运输点管理、快递员管理、网点申请管理(审核)、报价管理(时效报价)等。普通用户:注册登录、个人
- 归并排序简单解释:该算法是采用分治法,把数组不断分割,直至成为单个元素,然后比较再合并(合并的过程就是两部分分别从头开始比较,取出最小或最大
- SEATA概要seata 是alibaba 出的一款分布式事务管理器,他有侵入性小,实现简单等特点。我们能够使用seata 实现分布式事务管
- 前言2016年3月修改,结合自己的工作和平时学习的体验重新谈一下为什么要进行代码优化。在修改之前,我的说法是这样的:就像鲸鱼吃虾米一样,也许
- 一、demo简介1.效果展示如下图,我截了三个瞬间,但其实这是一个连续的动画,就是这个大圆不停地吞下小圆。2.这个动画可以拆分为两部分,首先
- 会话会话:用户打开浏览器进行的一系列操作直至关闭浏览器的过程看作是一次会话HTTP协议是无状态的,不能实现跟踪对话。比如进入一个网站,每次操
- 前言这篇文章主要介绍Spring Boot的统一功能处理模块,也是AOP的实战环节。1.用户登录权限效验在学习Spring AOP之前,用户
- 本文实例为大家分享了tryAcquire()、addWaiter()、acquireQueued()的用法 ,供大家参考,具体内容如下try
- 本文实例展示了WinForm实现为TextBox设置水印文字功能,非常实用的技巧,分享给大家供大家参考。关键代码如下:using Syste
- 本文实例讲述了java实现递归文件列表的方法。分享给大家供大家参考。具体如下:FileListing.java如下:import java.
- 本文实例讲述了C#实现读取注册表监控当前操作系统已安装软件变化的方法。分享给大家供大家参考。具体实现方法如下:private static
- 一、工具类代码public class TaskHelper {#region 多线程操作 &nbs
- 序列化序列化:将对象转换为二进制序列在网络中传输或保存到磁盘反序列化:从网络或磁盘中将二进制序列转换为对象注意:对象必须实现Serializ
- MyBatis-plus模糊查询在使用MyBatis-plus的时候,一些基础的增删改查可以不用再自己写sql了:public interf
- 引语:工作中有时候需要在普通的对象中去调用spring管理的对象,但是在普通的java对象直接使用@Autowired或者@Resource
- 一、概述数据透视表(Pivot Table)是一种交互式的表,可以进行某些计算,如求和与计数等,可动态地改变透视表版面布置,也可以重新安排行
- 配置两个parent的方法在向pom.xml 文件中添加依赖之前需要先添加spring-boot-starter-parent。spring