wxya🗒️Java Code Style 配置
type
status
slug
date
tags
summary
category
password
icon
googlealibaba落地使用Idea文件头模板Idea方法注释模板case使用JavaDoc 标准标签VsCode配置代码格式格式转换配置代码格式化VsCode 配置注释1. 注释 snippet2 注释 javadoc3 注释koroFileHeaderVscode配置 Java 环境
国内阿里用的多，落地使用使用阿里
alibaba
阿里系参考 Nacos 开源项目
Nacos的编码规范遵从于《阿里巴巴JAVA开发规约》和社区制定的Nacos代码风格文件。
落地使用
遵循GitHub - alibaba/p3c: Alibaba Java Coding Guidelines pmd implements and IDE plugin alibaba p3c 代码规范
具体代码格式规范参考 Apach Nacos（Nacos的编码规范遵从于《阿里巴巴JAVA开发规约》和社区制定的Nacos代码风格文件。）
- Alibaba p3c 插件开启
- Alibaba Nacos 具体实现 idea code style（从 nacos 仓库下载 ）
- Action on Sava 开启
- Git commit pre check 开启
- Alibaba Java Coding Guidelines(XenoAmess TPM) 插件安装开启
- 导入配置文件项目路径 style/style/code-style-for-idea.xml
- Action on Save使用配置
- 根据实际情况，可以关闭optimize import，对 xml sql 文件格式取消检查
- 提交代码检查
Idea文件头模板
创建java文件时候增加
Idea方法注释
模板
我用的Nacos 代码格式规范，会自动排序，我按照排序后的顺序排列标签
@create 是我自己加的不在 tag 标签范围内
update 描述直接 git 插件追踪不必维护
methName | methodName() |
param | groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters()) |
return | groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType()) |
userName | user() |
YEAR | groovyScript("import java.time.LocalDateTime; LocalDateTime.now().year", "") |
MONTH | groovyScript("import java.time.LocalDateTime; LocalDateTime.now().monthValue", "") |
DAY | groovyScript("import java.time.LocalDateTime; LocalDateTime.now().dayOfMonth", "") |
HOUR | groovyScript("import java.time.LocalDateTime; LocalDateTime.now().hour", "") |
MINUTE | groovyScript("import java.time.LocalDateTime; LocalDateTime.now().minute", "") |
ㅤ | ㅤ |
case
使用
输入/** 按下空格触发
JavaDoc 标准标签
javadoc 工具软件识别以下标签：
标签 | 描述 | 示例 |
@author | 标识一个类的作者 | @author description |
@deprecated | 指名一个过期的类或成员 | @deprecated description |
{@docRoot} | 指明当前文档根目录的路径 | Directory Path |
@exception | 标志一个类抛出的异常 | @exception exception-name explanation |
{@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
{@link} | 插入一个到另一个主题的链接 | {@link name text} |
{@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
@param | 说明一个方法的参数 | @param parameter-name explanation |
@return | 说明返回值类型 | @return explanation |
@see | 指定一个到另一个主题的链接 | @see anchor |
@serial | 说明一个序列化属性 | @serial description |
@serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
@serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
@since | 标记当引入一个特定的变化时 | @since release |
@throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
{@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
@version | 指定类的版本 | @version info |
ㅤ | ㅤ | ㅤ |
VsCode配置代码格式
格式转换
- 打开 IntelliJ IDEA。
- 导入
nacos-code-style-for-idea.xml： File -> Settings -> Editor -> Code Style。- 右上角点击 Manage -> Import Scheme，选择
IntelliJ IDEA Code Style XML，然后导入nacos-code-style-for-idea.xml。
- 导出为 Eclipse 格式 / .editorconfig：
- 在
File -> Settings -> Editor -> Code Style页面，点击 Manage。 - 选择 Export -> Eclipse XML。
- 选择一个路径保存
eclipse-java-style.xml。
配置代码格式化
- 安装Language support for Java ™ for Visual Studio Code 插件
- 个人配置 setting.json增加
VsCode 配置注释
snippet 使用classHeader
安装Javadoc-Generator 使用/**
1. 注释 snippet
classHeader
javadoc
2 注释 javadoc
输入/** 确定使用
安装Javadoc-Generator
3 注释koroFileHeader
koroFileHeader 参数不太好改
Vscode配置 Java 环境
Mac arm 系列
使用 idea 安装 java、maven，vscode
然后用 cscode 配置免去安装
VsCode 插件可以装一些 java 插件，impl 跳转、mybatis 跳转、run 启动这些的，基本就够用了
上一篇
SpringBoot banner config
下一篇
升级npm-check-updates
Loading...