当前位置: 首页 > article >正文

设置webstorm和idea符合Alibaba规范

只格式化自己更改的代码 ctrl+Shift+Alt+L

在这里插入图片描述

插件建议 Alibaba Java Coding Guidelines(新版本的idea不支持,有其他同名的非官方版可代替),使用方法在此不赘述

1、设置webstorm

包含 设置两个空格缩进,去掉行尾分号,去掉最后一个逗号,以及其他前后空格需求
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

2、设置idea

下载xml文件(更新于2022年) 下载eclipse-codestyle
这里只导入code Style ,不影响其他设置
导入方式如下,导入后还可以切换回你原来的配置
在这里插入图片描述在这里插入图片描述
如果是旧版的idea,需要安装Eclipse Code Formatter插件,然后选择File->Settings->Other Settings->Eclipse Code Formatter进行idea代码格式配置:将代码格式化文件eclipse-codestyle.xml,配置到插件中

新建javadoc注释

新建一个分组(避免与系统的混淆)
在这里插入图片描述

先填红框的这几项(注意空格以及*对齐)
在这里插入图片描述

方法注释必须包含 作者、邮箱、创建时间、描述、参数、返回值类

**
 * @Author : 名字(不建议使用系统的名字)
 * @Email : 邮箱
 * @Create : $date$ $time$
 * @Description : 
 $param$
 $return$
 * @throws $exception$
 */

设置作用范围,配置参数
在这里插入图片描述

在这里插入图片描述

param

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());

配置好后的使用方法 输入/* 按Tab键 (异常那个不知道为什么没带出来 手动输入一下,如果输入错误会变成红色,如果方法没有异常,删掉*@throws
)。注意输入参数的文字描述等。
在这里插入图片描述

在这里插入图片描述

类/接口/枚举注释必须包含 作者、邮箱、创建时间、类职责描述

在这里插入图片描述

作用范围和参数配置方法同上

**
 * @Author : 名字
 * @Email : 邮箱
 * @Create : $date$ $time$
 * @Description : 
 */

在这里插入图片描述

配置好后的使用方法 输入/** 按Tab键 (注意输入类描述)
在这里插入图片描述

TODO,这里有个特殊处理,各自用各自的TODO,方便筛选处理,webstorm和idea均适用

在这里插入图片描述

作用范围(我全选了,大家随意)

// todo-wyw  $DATE$ $TIME$ by wuyw , 

参数设置
在这里插入图片描述

设置补全键,这里我用的enter,大家随意,可以延用Tab
在这里插入图片描述

设置TODO起作用
在这里插入图片描述

输入tdwyw 按enter键
在这里插入图片描述

筛选自己的TODO
在这里插入图片描述


http://www.kler.cn/a/160483.html

相关文章:

  • React Native 全新架构来了
  • javascript 函数【知识点整理】
  • MySQL数据库:SQL语言入门 【上】(学习笔记)
  • uniapp 设置安全区域
  • 零基础玩转IPC之——海思平台实现P2P远程传输实验(基于TUTK,国科君正全志海思通用)
  • HTMLCSS: 实现可爱的冰墩墩
  • 【Docker】从零开始:17.Dockerfile基本概念
  • 指定分隔符对字符串进行分割 numpy.char.split()
  • 自然语言处理(NLP)技术-AI生成版
  • Flinksql bug :Illegal mixing of types in CASE or COALESCE statement
  • 按天批量创建间隔分区表(DM8:达梦数据库)
  • 【PTA-C语言】编程练习4 - 数组Ⅰ
  • HarmonyOS4.0从零开始的开发教程08构建列表页面
  • 17、XSS——session攻击
  • 【动态规划】LeetCode-面试题 17.16. 按摩师
  • 配置阿里云CLI-aliyun命令与安装ossutil
  • 数据结构之交换排序
  • Flink优化——数据倾斜(二)
  • ssh远程连接服务器
  • ELK的日志解决方案
  • PACS源码,医学影像传输系统源码,全院级应用,支持放射、超声、内窥镜、病理等影像科室,且具备多种图像处理及三维重建功能
  • Kafka 的消息格式:了解消息结构与序列化
  • 2023字节跳动软件测试工程师面试题及答案分享
  • 万界星空科技MES系统在工业生产中的应用
  • WordPress发布文件随机设置作者昵称信息
  • gitlab高级功能之CI/CD组件 - 原理介绍(一)