首页 > 其他分享 >idea 设置代码样式

idea 设置代码样式

时间:2024-09-03 10:49:28浏览次数:15  
标签:return 样式 代码 idea 注释 -- params date 模板

设置类注释模板

  类注释:File-->Settings-->Editor-->File and CodeTemplates

  将如下代码拷贝到上图右侧空白区域即可(这个更为详细,具体用哪个自己决定)

/**
 *
 * @description 
 * @author ${USER}
 * @date ${DATE}
 * @version 1.0
 * @email [email protected]
 */

  需要注意的是:class的注释,只有在新建文件的时候,会自动生成。

说明:

阿里巴巴规范指定:所有的类都必须添加创建者和创建日期,且类的日期的设置统一为 yyyy/MM/dd 的格式。

如果你的日期标签不是上述格式,我们可以通过下面进行指定。

或者使用这个

/**
 * 
 * @description 
 * @author ${USER}
 * @date ${YEAR}/${MONTH}/${DAY}
 * @version 1.0.0
 * @email [email protected]
 */

  举个例子,复制原文件生成的新文件,是无法重新生成注释的,或者你把原来的注释删除,重新生成也是不行的,这一点相当恶心人(下面有解决办法)。

  如上图所示,我的date显示格式为:2020年07月10日 0010 12:03,估计大家的日期格式也会五花八门,造成这样的原因,一般是修改了windows系统时间的显示格式。那该如何生成我们想要的日期格式呢?

  配置这个就可以啦

/**
 *
 * @description 
 * @author ${USER}
 * @date ${YEAR}-${MONTH}-${DAY} ${TIME}
 * @version 1.0
 * @email [email protected]
 */

修改Class、Interface和Enum类的模板

说点题外话(可以不看)

  之所以我们设置了File Header后,新建java文件能引用这个里的注释模板,是因为它引入了我们刚才修改的文件(不用我们管,idea已经配好了)

20200827

  上面的类注释,只能在新建java类时有效,但在实际开发过程中,我们通常会直接复制类似的java类,来快速完成类的创建,而往往不是同一人开发的,所以会导致类的注释模板与自己之前的不统一的情况,所以,有必要创建一个可以通过调用快捷键来生成类注释模板。

  新建组和模板的方法,方法注释有讲解,因为是后期添加的,所以,可以先看方法注释,然后再回来创建。

  配置快捷键,这里,我定义为**

  设置该模板的使用范围:java--》comment(注释,勾选其它的,在别的地方,其实也用不到,所以没有勾选的必要)

  配置模板

**
 *
 * @description 
 * @author $USER$
 * @date $DATE$
 * @version 1.0
 * @email [email protected]
 */

  配置变量对应的函数表达式  

  在需要添加类注释的地方,打上/**,按Tab键即可 

  注意:这里没有函数year()、month()和day(),用来表示日期的,只能是date(),所以,这里无法自定义年月日的表现形式,目前没有解决办法,只能手动修改展示格式。

方法注释

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

  点击右上角的+号,然后选择Template Group,然后输入group的name,我这里输入:Java,然后点ok 

  选中刚才创建的MyGroup,然后再次点击右侧的+,这次选择的是第一个Live Template。取名为 *(必须是这个)

  将如下代码拷贝到上图左侧空白区域

旧版

*
* 
* @attention 
* @date $date$ $time$
$params$
* @return $return$
*/

  注意:必须是*开头,而不是/**开头,另外这个*必须顶格。

2024版

**
 * 
 * @attention 
 * @date $date$ $time$
 $params$
 $return$
 */

  配置好模板后,点击右侧的 Editor variables配置变量

  模板参数对应的值如下:

$user$   user()
$date$   date()
$time$   time()
$params$ groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ' '}else{result+='\\n' + ' * @param ' + params[i] + ' '}}; return result;}", methodParameters());
$return$ groovyScript("def returnType = \"${_1}\"; def result = '* @return ' + returnType; return result;", methodReturnType());

  将其对应的模板值,依次拷贝到对应的Expression中,如下图所示

  点击模板页面最下方的警告define,来设置将模板应用于哪些场景,选择Everywhere-->Java即可。

  如果曾经修改过,则显示为change而不是define。

  如果应用范围太多,则将不能显示change按钮,我们只能选中要修改的模板,右键

说明:Java类注释模板,目前使用的是”**“,而不是”lzs“!

  意思是在注释的时候生效(全选也没有意义和必要),点击Apply,完事。

  如何使用方法注释模板?在类的方法上,输入/*,按Tab键即可生成 

  注意:这种配置方法还存在一个漏洞,那就是:当我们的类或者方法抛出异常后,再调用生成的模板,无法像eclipse那样,生成的注释没有@throws,需要自己手动添加,也挺恶心人的。

添加步骤注释模板

  在实际开发过程中,往往需要执行很多步骤才能完成,比如说接口,所以,如果需要的话,把这个也加上。

  按照上面的方法进行即可。

说明:Java类注释模板,目前使用的是”**“,而不是”lzs“!

  在需要添加注释的地方,输入:step

  按Tab键或者Enter键均可 

 

  date:2021-07-06

添加日期注释模板

修改 JAVA/HTML/XML 等文件的默认单行注释方式

  在idea中,使用单行注释快捷键注释当前行Ctrl+/,注释会直接顶格,很丑

  我们想要的样式是,注释对齐语句,和注释的语句对齐,如何实现? 

  File--》Settings--》Editor--》Code Style--》

  修改Java 的单行注释:Java--》Code Generation

  看图操作即可

  修改HTML 的单行注释 

  修改 XML 的单行和多行注释 

  将两个都取消勾选 

  对于JavaScript也一样的操作方式。

修改代码样式

换行符使用Unix 格式。

单行字符数限制不超过 120 个,超出需要换行。

 

写在最后

  哪位大佬如若发现文章存在纰漏之处或需要补充更多内容,欢迎留言!!!

 相关推荐:

标签:return,样式,代码,idea,注释,--,params,date,模板
From: https://www.cnblogs.com/Marydon20170307/p/18394120

相关文章

  • 海马算法(SHO)优化支持向量机原理及Matlab代码
    目录0引言1数学模型2优化方式3Maltab代码3.1伪代码3.2SHO主函数代码3.3SHO-SVM4视频讲解0引言海马算法(SeaHorseOptimizer,SHO)是ShijieZhao于2023年基于自然界中海马的运动、捕食和繁殖行为提出的群体智能算法。SHO算法两个阶段,SHO分别模拟了海马的不同运......
  • 非洲秃鹫算法(AVOV)优化BP神经网络原理及Matlab代码
    目录0引言1 数学模型2优化方式3Matlab代码3.1伪代码3.2AVOA主函数代码3.3AVOA-BP4视频讲解0引言非洲秃鹫算法(Africanvulturesoptimizationalgorithm,AVOA)是BenyaminAbdollahzadeh等人于2021年提出的群智能算法,该算法通过模拟非洲秃鹫典型的领导者-追随......
  • 非洲秃鹫算法(AVOA)优化支持向量机原理及Matlab代码
    目录0引言1 数学模型2优化方式3Matlab代码3.1伪代码3.2AVOA主函数代码3.3AVOA-SVM4视频讲解0引言非洲秃鹫算法(Africanvulturesoptimizationalgorithm,AVOA)是BenyaminAbdollahzadeh等人于2021年提出的群智能算法,该算法通过模拟非洲秃鹫典型的领导者-追随......
  • 如何修改PbootCMS默认面包屑导航样式及自定义设置方法(如何自定义 PbootCMS 的面包屑导
    在PbootCMS中,面包屑导航是一个非常重要的导航元素,用于帮助用户了解当前页面的位置和路径。系统默认的面包屑样式可能无法满足所有需求,因此需要进行一定的自定义操作。以下是详细的自定义方法:调用面包屑导航的基本方式html {pboot:position}自定义面包屑导航参数可以......
  • 在Java中23种设计模式,分类以及代码示例
    在Java中23种设计模式,分类以及代码示例在Java中,设计模式可以分为23种,以三个不同的分类进行划分。1.创建型模式(CreationalPatterns):单例模式(Singleton)原型模式(Prototype)工厂方法模式(FactoryMethod)抽象工厂模式(AbstractFactory)建造者模式(Builder)2.结构型模式(Structura......
  • 「代码随想录算法训练营」第五十二天 | 图论 part10
    目录Floyd算法题目:97.小明逛公园A*算法题目:126.骑士的攻击最短路算法总结Floyd算法Floyd算法用于求解多源最短路问题(求多个起点到多个终点的多条最短路径)。在前面学习的dijkstra算法、Bellman算法都是求解单源最短路的问题(即只能有一个起点)。注意:Floyd算法对边的权值正负没......
  • Echarts + 低代码 :可视化如何赋能企业的创新之路?
    前言数据驱动已经成为企业决策和业务优化的关键所在,在数字化时代,高效的数据分析与可视化呈现是实现智能决策的关键。利用低代码开发平台,企业可以快速构建满足业务需求的应用系统,实现对各类数据源的便捷接入。结合Echarts等可视化工具,复杂的数据信息能够以直观、富交互性的图表......
  • 代码随想录算法训练营|Day01 LeetCode 704.二分查找,27.移除元素,977.有序数组的平方
    数组理论基础数组是存放在连续空间上的相同类型数据的集合数组的元素是不能删的,只能覆盖704.二分查找LeetCode:704.有序数组的平方classSolution{public:intsearch(vector<int>&nums,inttarget){intlength=nums.size();inti=0......
  • Vue2 - 最新实现百度地图3D立体感视角教程及示例代码,利用WebGL实现3d百度地图详细流程
    前言如果您需要Vue3版本,请访问在vue2|nuxt2项目开发中,详解实现“安装引入百度地图webgl技术,实现3d地图教程”将百度地图变成3D视角效果,让百度地图平面2D视图和3D立体视图进行切换渲染显示,vue如何实现百度地图的三维立体地图效果,解决WebGL引入报错或无效、3D地图......
  • 【爬虫开发】爬虫开发从0到1全知识教程第9篇:Mongodb数据库,介绍【附代码文档】
    本教程的知识点为:爬虫概要爬虫基础爬虫概述知识点:1.爬虫的概念requests模块requests模块知识点:1.requests模块介绍1.1requests模块的作用:数据提取概要数据提取概述知识点1.响应内容的分类知识点:了解响应内容的分类Selenium概要selenium的介绍知识点:1.sele......