共计 3027 个字符,预计需要花费 8 分钟才能阅读完成。
今日分享开始啦,请大家多多指教~
每一个公司,团队的代码格调可能都不一样,只有团队内有本人对立的格调就好。接下来,介绍 Google Java 代码格调,并且如何在 IDEA 和 Ecplise 两种比拟风行的 Java 集成开发环境中配置 Google Java 代码格调。
Google Java Style 介绍
源文件根底
文件名
Java 源文件名辨别大小写的,并且首字母大写,以.java 扩展名完结。
文件编码
Java 源文件编码格局为 UTF-8。
特殊字符
- 空格字符:除了行结束符之外,ASCII 程度空格字符(0x20)是惟一呈现在源文件中任何中央的空格字符。这也意味着,字符串和字符文字中的所有其余空白字符均被本义。制表符不用于缩进。
- 非凡的转义序列:所有转义序列(\ b,\ t,\ n,\ f,\ r,\ “,\’和 \),不是八进制(例如 \ 012)或 Unicode(例如 \ u000a)的本义。
- 非 ASCII 字符:对于其余的非 ASCII 字符,则应用理论的 Unicode 字符(例如∞)或等效的 Unicode 本义符(例如 \ u221e)。用哪种取决于使代码更易于浏览和了解,只管 Unicode 会在字符串文字之外进行本义,然而不倡议不在正文中应用。例如 String unitAbbrev = “μs”,没必要写成 String unitAbbrev = “\u03bcs”。
源文件构造
一个 Java 源文件,按以下程序组成,并且每个局部空一行分隔开:
- 许可或版权信息(如果有)
- Package 语句,并且不换行的
- Import 语句,最初不要应用通配符导入,无论是动态导入还是其余形式;每一行导入语句都是不换行的;所有动态导入都在一个块中,所有非动态导入也在同一个块中,块之间用一空白行分隔开;在每个块中,导入的名称均按 ASCII 排序程序显示。
- 顶级类定义
每一个顶级类都应该在一个独自的源文件中,对于一个类中的内容,最好是无意识地对类中的内容按某种规定排序排版,例如新的办法个别增加在类的尾部,这样咱们能够依据工夫线索理解这些办法何时加进来的;再比方,当一个类具备多个构造函数或多个具备雷同名称的办法时,它们将程序呈现,并且它们之间没有其余代码(甚至没有公有成员)。
格式化
前提须知,下文中提及的块状构造是指类的主体,办法或构造函数。
花括号
if,else,for,do,while 等语句块应用花括号,即便花括号内容是空的或者只有一行语句。
对于内容非空的花括号块,遵循以下规定:
- 左括号前不换行
- 左括号后换行
- 右括号前换行
- 右括号后换行,例如办法块,构造函数,类的主体括号状况下才换行。有些整体搭配不换行,例如 esle 后面的右括号,try 块的右括号等。
对于一些空内容地块,以下两种形式都可承受:
void doNothing() {}
void doNothingElse() {}
缩进
对于一些块构造等的缩进,倡议 2 个空格,并且正文也最好和代码缩进保持一致。
每行一个申明
每个语句后都有一个换行符,不要将多行语句都写在同一行。
列数限度
Java 代码的列数限度为 100 个字符,一个字符是指一个 Unicode 字符。除非另有阐明,否则超出该限度的任何行都必须进行换行。
不过也有一些例外能够超过此限度,例如:
- Javadoc 中的长 URL 或长的 JSNI 办法援用
- package 和 import 语句
- 正文中的命令行,因为可能须要将其拷贝到 shell 中执行
不要程度对齐
程度对齐是在下一行的代码中增加一些空格,以致与上一行的某个标识符对齐。语法容许这样做,然而不举荐,因为后续可能会再批改代码,可能导致不再对齐,而后再对齐的话须要节约额定的工夫精力。
枚举类
如果一个枚举常量有办法或者正文,在每个枚举常量的逗号前面,最好换一行再定义下一个枚举常量。
如果一个枚举常量没有有办法或者正文,则能够不换行。
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。
修饰符
类或者成员变量的定义应用修饰符时,按以下程序进行润饰。
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;
IDEA 配置 Google Java Style
点击 File(文件)–> Setting( 设置) –> Editor(编辑) –> Code Style(代码格调),而后再点击 Scheme 左边的设置按钮,Import Scheme,IntelliJ IDEA code style xml。最初选中本地下载好的 xml 文件。
而后为选中导入的主题取个名称,在最下面 Scheme 选项选中咱们的主题确定即可。
而后咱们在应用 IDEA 开发代码过程中,应用快捷键(默认是 ctrl + alt + L,也能够批改设置这个快捷键),即可按 google 格调进行格式化代码。
Ecplise 配置 Google Java Style
门路:Window – Preferences – Java – Code Style – Formatter – Import,而后导入 xml 文件,最初抉择 GoogleStyle,保留即可。
小结
在日常开发中,多人团队合作开发一个我的项目是很常见的,特地是大公司,这就会波及到多人在一个工程上开发代码。无规矩不成方圆,一个好的代码格调,更加有利于团队合作,缩小代码抵触,进步代码可浏览性,好看性。
今日份分享已完结,请大家多多包涵和指导!