编程技术是改变世界的力量。
本站
当前位置:网站首页 > 后端语言 > 正文

IDEA代码格式和JavaDoc这么设置,代码再也不丑了

gowuye 2024-04-04 11:56 8 浏览 0 评论

概述

经常看到团队内部同事的代码格式很丑陋,有的代码一行很长很长,有的运算符前后没有空格,有的没有javadoc,各有各的特色,林林总总,导致代码阅读存在很大的阻碍。那么看了这篇文章,大家就不用担心了,通过IDEA的设置,可以一键格式化代码,每个人都给我装起来呀。

代码格式设置

1.进入插件界面:File->Settings->Plugins,搜索 eclipse code formatter,如已有插件则不需安装,如没有,点击Search in repositories自动搜索线上插件。

  1. 导入codestyle.xml 点击OK


codestyle.xml

  1. 依次点击进入插件界面:File->Settings->Editor->Code Style->Java->Import Scheme->Intellij IDEA code style XML,导入下面的ideacodestyle.xml

ideacodestyle.xml\

  1. 完成,页面通过格式化,就会统一根据规定的格式进行格式化。
  • 通过下面的按钮或者快捷键Ctrl+Alt+L 进行格式化
  • 最重要的是,如果只想要格式化你修改部分的代码,记得选中然后进行格式化。

JavaDoc模板设置

本文档红色部分为需要修改为实际内容

类注释

示例:

/**
* <p>描 述:这个是将resourceId换成resourceVo的工厂类</p>
*
* @author: xx (xx@xx.com.cn)
* @date: ${DATE}  ${TIME}
* @version: 1.0.1
*/
复制代码

IDEA设置:

在idea的setting->editor->file and code templates里面增加以下内容可在新增类时自动生成模板

/**
* <p>描 述:</p>
*
* @author: xx (@xx.com.cn)
* @date: ${DATE}  ${TIME}
* @version: 1.0.0
*/
复制代码

方法注释

示例:

/**
 *<p>描述:</p>
 *
 * @param content 搜索内容
 * @param sort 搜索排序
 * @param gameTypeIds 搜索类型
 * @param years 搜索年份
 * @param page 页码
 * @param pageSize 每页个数
 * @param memberId 用户ID
 * @param token 用户token
 * @param onlyCollect 是否只展示收藏
 * @author xx (xx@xx.com.cn)
 * @date 2020/6/12 16:02
 */
复制代码

IDEA设置:

  1. 在idea的setting->editor->live templates里面新增一个模板,本例新增一个名为func对模板,并填入以下内容:
/**
*<p>描述:</p>
$params$
* @return $return$
* @author xx (xx@xx.com.cn)
* @date $DATE$ $TIME$
*/
复制代码
  1. 点击edit variables并按以下图示设置:

groovy脚本为:

groovyScript("def result=''; def params="${_1}".replaceAll('[\\[|\\]|\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\n' : '')}; return result", methodParameters())
复制代码
  1. 配置完成以后,在需要生成注解对函数前面打 /fun并按tab键(具体根据自己的idea设置)可自动生成对应注解,并完善即可。

变量注解

示例:

/**

  • 最后刷新时间

*/


作者:JAVA旭阳
链接:https://juejin.cn/post/7131535711953649678
来源:稀土掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

相关推荐

爱上开源之golang入门至实战第四章-切片(Slice)

前言Go数组的长度不可改变,在特定场景中这样的集合就不太适用,Go中提供了一种灵活,功能强悍的内置类型切片("动态数组"),与数组相比切片的长度是不固定的,可以追加元素,在追加时可...

Go语言入门必知教程-切片

切片是一种灵活的和可扩展的数据结构,用于实现和管理数据集。切片由多个元素组成,所有元素都是相同类型的。切片是动态数组的一部分,可以根据需要进行增长和收缩。与数组一样,切片也可以索引。切片具有容量和长度...

Go语言基础-切片

切片是什么?切片是Go语言的一种数据结构。和数组相似,不过切片可以在它的结尾增加更多的元素。这样可变长度在实际编程中更为有用。声明切片切片的声明和数组也很相似,只是声明切片时不需要指定大小。例:va...

5分钟掌握GO中切片的基本使用方法

最近Golang越来越火,不少小伙伴都纷纷开始学习Golang,但对于原先为C++或者JAVA的同学,用习惯了数据、list、vector等,会对Go的切片slice不习惯,下面整理出go中slice...

揭秘 Go 切片(Slice)的秘密

当向切片添加新参数时,底层数组会发生什么变化?它会扩展以容纳更多元素吗?在这篇文章中,我们将深入探讨切片的内部工作原理,以及如何利用这些知识来进行更好的内存管理和性能优化。具体而言,我们将探索Go...

【Go语言slice详解】深入掌握Go语言中的slice类型及常用操作!

Go语言中的slice(切片)是一种非常方便的数据结构,可以动态地增加或减少其元素数量,且可以访问底层数组的任意一个子序列。本文将对Go语言中的slice进行详细的讲解。Slice的定义在Go语言中,...

掌握GO中的Slice,这就够了

最近Golang越来越火,不少小伙伴都纷纷开始学习Golang,但对于原先为C++或者JAVA的同学,用习惯了数据、list、vector等,会对Go的切片slice不习惯,下面整理出go中slice...

golang2021面向对象(26)Go语言类型内嵌和结构体内嵌

结构体可以包含一个或多个匿名(或内嵌)字段,即这些字段没有显式的名字,只有字段的类型是必须的,此时类型也就是字段的名字。匿名字段本身可以是一个结构体类型,即结构体可以包含内嵌结构体。?可以粗略地将这个...

2022-11-13:以下go语言代码中,如何获取结构体列表以及结构体内

2022-11-13:以下go语言代码中,如何获取结构体列表以及结构体内的指针方法列表?以下代码应该返回{"S1":["M1","M2"],"S...

Go语言文件和目录操作

文件和目录操作概述一、文件和目录操作概述在计算机中,文件和目录是存储数据的重要方式。在Go语言中,我们可以使用os和io/ioutil包提供的函数和结构体来进行文件和目录操作。本文将详细介绍Go语言中...

跟我一起学习go语言(五)golang中结构体的初始化方法

1、自定义一个结构体typeVertexstruct{X,Yfloat64}2、初始化方法-指针:rect1:=new(Vertex)rect2:=&Vertex...

Go复合数据类型:结构体

一种通用的、对实体对象进行聚合抽象的能力,在Go中,提供这种聚合抽象能力的类型是结构体类型,也就是struct。自定义一个新类型在Go中,我们自定义一个新类型一般有两种方法。第一种是类型定义...

Go语言基础:方法

导读在阅读本文章前,假定你具备如下能力:?已掌握结构体1.方法1.1方法的概念在理解程序中方法的概念时,我们先看看现实中的一些情况,这样相对比较好理解一些。在农村的朋友可能会知道,在医疗落后的情况...

为什么 Go 语言 struct 要使用 tags

在Go语言中,struct是一种常见的数据类型,它可以用来表示复杂的数据结构。在struct中,我们可以定义多个字段,每个字段可以有不同的类型和名称。除了这些基本信息之外,Go还提供了s...

一文带你掌握掌握 Golang结构体与方法

1.Golang结构体的概念及定义结构体是Golang中一种复合类型,它是由一组具有相同或不同类型的数据字段组成的数据结构。结构体是一种用户自定义类型,它可以被用来封装多个字段,从而实现数据的...

取消回复欢迎 发表评论: