DIEA ,Ecplise 配置谷歌代码风格 Google Java Style

本文详细介绍了Java编程中的编码规则,包括特殊字符处理、源文件结构、格式化要求、命名约定以及GoogleJavaStyle标准。此外,还提到了如何在IDEA中配置风格,以及一套全面的学习资料,覆盖了从基础到进阶的内容,旨在帮助Java开发者提升技能。
摘要由CSDN通过智能技术生成

特殊字符

  • 空格字符:除了行结束符之外,ASCII 水平空格字符(0x20)是唯一出现在源文件中任何地方的空格字符。这也意味着,字符串和字符文字中的所有其他空白字符均被转义。制表符不用于缩进。

  • 特殊的转义序列:所有转义序列 (\ b, \ t, \ n, \ f, \ r, \ ", \ ’ 和 \\),不是八进制(例如 \ 012)或 Unicode(例如 \ u000a)的转义。

  • 非 ASCII 字符:对于其余的非 ASCII 字符,则使用实际的 Unicode 字符(例如∞)或等效的 Unicode 转义符(例如 \ u221e)。用哪种取决于使代码更易于阅读和理解,尽管 Unicode 会在字符串文字之外进行转义,但是不建议不在注释中使用。例如 String unitAbbrev = "μs",没必要写成 String unitAbbrev = "\u03bcs"

源文件结构

一个 Java 源文件,按以下顺序组成,并且每个部分空一行分隔开:

  1. 许可或版权信息(如果有)

  2. Package 语句,并且不换行的

  3. Import 语句,最后不要使用通配符导入,无论是静态导入还是其他方式;每一行导入语句都是不换行的;所有静态导入都在一个块中,所有非静态导入也在同一个块中,块之间用一空白行分隔开;在每个块中,导入的名称均按 ASCII 排序顺序显示。

  4. 顶级类定义

每一个顶级类都应该在一个单独的源文件中,对于一个类中的内容,最好是有意识地对类中的内容按某种规则排序排版,例如新的方法一般添加在类的尾部,这样我们可以根据时间线索了解这些方法何时加进来的;再比如,当一个类具有多个构造函数或多个具有相同名称的方法时,它们将顺序出现,并且它们之间没有其他代码(甚至没有私有成员)。

格式化

前提须知,下文中提及的块状结构是指类的主体,方法或构造函数。

花括号

if,else,for,do,while 等语句块使用花括号,即使花括号内容是空的或者只有一行语句。

对于内容非空的花括号块,遵循以下规则:

  • 左括号前不换行

  • 左括号后换行

  • 右括号前换行

  • 右括号后换行,例如方法块,构造函数,类的主体括号情况下才换行。有些整体搭配不换行,例如 esle 前面的右括号,try 块的右括号等。

return () -> {

while (condition()) {

method();

}

};

return new MyClass() {

@Override public void method() {

if (condition()) {

try {

something();

} catch (Exception e) {

recover();

}

} else if (otherCondition()) {

somethingElse();

} else {

lastThing();

}

}

};

对于一些空内容的块,以下两种方式都可接受:

void doNothing() {}

void doNothingElse() {

}

缩进

关于一些块结构等的缩进,建议2个空格,并且注释也最好和代码缩进保持一致。

每行一个声明

每个语句后都有一个换行符,不要将多行语句都写在同一行。

列数限制

Java 代码的列数限制为100个字符,一个字符是指一个 Unicode 字符。除非另有说明,否则超出该限制的任何行都必须进行换行。

不过也有一些例外可以超过此限制,例如:

  • Javadoc 中的长 URL 或长的 JSNI 方法引用

  • package 和import 语句

  • 注释中的命令行,因为可能需要将其拷贝到 shell 中执行

不要水平对齐

水平对齐是在下一行的代码中添加一些空格,致使与上一行的某个标识符对齐。语法允许这样做,但是不推荐,因为后续可能会载修改代码,可能导致不再对齐,然后再对齐的话需要浪费额外的时间精力。

// 这是推荐的,按正常的一个空格即可

private int x;

private Color color;

// color和x对齐,没必要

private int x;

private Color color;

枚举类

如果一个枚举常量有方法或者注释,在每个枚举常量的逗号后面,最好换一行再定义下一个枚举常量。

private enum Answer {

YES {

@Override public String toString() {

return “yes”;

}

},

NO,

MAYBE

}

如果一个枚举常量没有有方法或者注释,则可以不换行。

private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS }

变量声明

每个变量声明语句只声明一个变量,不要使用 int a, b;这种多变量的声明。但是 for循环 的头部中可以接受多个变量声明 。

需要时才声明,不要在代码块的开头就声明局部变量,而是应该在靠近使用局部变量的地方声明它们,以最小化它们的作用域。局部变量应该声明的时候就进行初始化,或者声明后,要立即初始化。

数组

[] 方括号应该是类型的一部分,而不是变量,所以应该使用 String[] args,而不是 String args[]

Switch 语句

在 Switch 代码块内,如果一个 case 小代码块直接穿透到下一个 case(例如没有以 break,continue,return 或者抛异常结尾),则需要在最后一个 case 后面注释说明原因;最后一定要写 default 块,即使没有执行任何代码,但是如果 switch 的是枚举类型,并且 case 列出所有的枚举值了,可以不用写 default。

switch (input) {

case 1:

case 2:

prepareOneOrTwo();

// 这里说明为什么穿透,case1和case2的情况下也要执行case3的内容

case 3:

handleOneTwoOrThree();

break;

default:

handleLargeNumber(input);

}

修饰符

类或者成员变量的定义使用修饰符时,按以下顺序进行修饰。

public protected private abstract default static final transient volatile synchronized native strictfp

字面量

long 类型的值,数字后面加大写的 L,禁止使用小写的 l,因为 l 和 1 很像,容易误导。例如 300000L 而不是 300000l 。

标识符命名规则

package 命名规则

package 的包名全部小写,而且不要出现下划线(_),例如使用 com.nobody.chenpi,而不是 com.nobody.chenPi 或者 com.nobody.chen_pi

类命名规则

类名遵循 UpperCamelCase 规则,即大写字母开头的驼峰规则。类名使用名词或者名称短语,例如Person,GoodPerson。接口使用名称或者名称短语,有时也可以使用形容词或者形容词短语,例如Readable。

测试类名字以需要测试的类的名字开头,并且以 Test 结尾,例如 HashTest 。

方法命名规则

方法命名遵循 LowerCamelCase 规则,即小写字母开头的驼峰规则。方法名词使用动词或者动词短语,例如 sendMessage。

常量命名规则

常量名称全部大写,并且单词之间用下划线分隔开。

private static final Long MAX_NUM = 10000L;

还有许多 Google 代码风格规则就不一一讲解了,感兴趣的可以到 Google 官方网站查看。

Google Java Style 下载



可以在我的个人 github 下载:https://github.com/LucioChn/google-code-style

IDEA 配置 Google Java Style



点击 File(文件)–> Setting(设置) –> Editor(编辑) –> Code Style(代码风格),然后再点击 Scheme 右边的设置按钮,Import Scheme,IntelliJ IDEA code style xml。最后选中本地下载好的xml文件。

在这里插入图片描述

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Java)

最后

手绘了下图所示的kafka知识大纲流程图(xmind文件不能上传,导出图片展现),但都可提供源文件给每位爱学习的朋友

image.png

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
]

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Java)

[外链图片转存中…(img-ewuMxcQR-1713822692076)]

最后

手绘了下图所示的kafka知识大纲流程图(xmind文件不能上传,导出图片展现),但都可提供源文件给每位爱学习的朋友

[外链图片转存中…(img-KvmfGdTW-1713822692076)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值