DIEA ,Ecplise 配置谷歌代码风格 Google Java Style
我是陈皮,一个在互联网 Coding 的 ITer,微信搜索「陈皮的JavaLib」第一时间阅读最新文章,回复【资料】,即可获得我精心整理的技术资料,电子书籍,一线大厂面试资料和优秀简历模板。
目录
- 引言
- Google Java Style 介绍
- 源文件基础
- 源文件结构
- 格式化
- 标识符命名规则
- Google Java Style 下载
- IDEA 配置 Google Java Style
- Ecplise 配置 Google Java Style
引言
在日常开发中,多人团队协作开发一个项目是很常见的,特别是大公司,这就会涉及到多人在一个工程上开发代码。无规矩不成方圆,一个好的代码风格,更加有利于团队协作,减少代码冲突,提高代码可阅读性,美观性。
每一个公司,团队的代码风格可能都不一样,只要团队内有自己统一的风格就好。接下来,介绍 Google Java 代码风格,并且如何在 IDEA 和 Ecplise 两种比较流行的 Java 集成开发环境中配置 Google Java 代码风格。
如果不看 Google 代码风格详细介绍的,可以下拉到最后查看 IDEA 和 Ecplise 配置 Google Java Style 教程和 Google Java Style 文件下载。
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 块的右括号等。
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文件。
然后为选中导入的主题取个名称,在最上面Scheme选项选中我们的主题确定即可。
然后我们在使用 IDEA 开发代码过程中,使用快捷键(默认是 ctrl + alt + L,也可以修改设置这个快捷键),即可按 Google 风格进行格式化代码。
package com.nobody.exception;import lombok.Getter;/*** @Description 自定义通用异常枚举类* @Author 陈皮* @Date 2020/10/23* @Version 1.0*/
@Getter
public enum CommonErrorEnum implements BaseErrorInfo {/*** 成功*/SUCCESS("200", "成功!"),/*** 请求的数据格式不符!*/BODY_NOT_MATCH("400", "请求的数据格式不符!"),/*** 未找到该资源!*/NOT_FOUND("404", "未找到该资源!"),/*** 服务器内部错误!*/INTERNAL_SERVER_ERROR("500", "服务器内部错误!"),/*** 服务器正忙,请稍后再试!*/SERVER_BUSY("503", "服务器正忙,请稍后再试!");private String errorCode;private String errorMsg;CommonErrorEnum(String errorCode, String errorMsg) {this.errorCode = errorCode;this.errorMsg = errorMsg;}
}
Ecplise 配置 Google Java Style
路径:Window - Preferences - Java - Code Style - Formatter - Import,然后导入 xml 文件,最后选择 GoogleStyle,保存即可。
DIEA ,Ecplise 配置谷歌代码风格 Google Java Style相关推荐
- Google Java Style 中文版
基于官方文档2013.12.19最后一次改动. 翻译人:Weir Zhang (zh.weir) 旁白:水平有限,很多地方只是意译.不准确的地方,大家以原版文档为准. 原版地址:http://goog ...
- 几个简单代码片段-- Google C++ style guide
欧洲杯,德国VS意大利.战车遇到浪漫之师,结果如何? Who Cares!!! 开球之前,review一下近期写的代码,发现一些代码写的不是很规范.于是,重新温习一下 Google C++ style ...
- Google Java编程风格指南中文版
作者:Hawstein 出处:http://hawstein.com/posts/google-java-style.html 声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|C ...
- Google Java编程风格指南中文版(转)
作者:Hawstein 出处:http://hawstein.com/posts/google-java-style.html 声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|C ...
- Google Java编程风格指南(献给那些没有良好编码习惯的程序员们)
作者:Hawstein 出处:http://hawstein.com/posts/google-java-style.html 声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|C ...
- Google Java编程风格指南
Hawstein's Blog Home Archive Categories Sitemap About Su 前言 源文件基础 源文件结构 格式 命名约定 编程实践 Javadoc 后记 前言 这 ...
- Google Java 编码规范
IncTech开发者团队,承接App,微信,及其后台开发.更多精彩技术文章和技术研究,欢迎访问 我们的官网 http://www.inctech.cn 转载自 http://www.hawste ...
- Google C++ Style Guide - Google C++ 风格指南
Google C++ Style Guide - Google C++ 风格指南 Every major open-source project has its own style guide: a ...
- python代码风格
pep8:Python代码风格检查工具 Python官网定义的代码风格 PEP 0008 – Style Guide for Python Code. pep8是检测编码风格是否符合 PEP 0008 ...
最新文章
- 马歇尔·赫伯特:人工智能的前沿技术与实例分析
- 【Codeforces #167 Div1 Div2】Solutions
- Apache检查配置文件语法
- [html] 写一个滚动吸顶的布局
- 关于分辨率和地图打印的一些问题
- 开源不等于免费!谷歌如何通过安卓开源成为移动时代霸主? | 涛滔不绝
- html脚本类型,HTML脚本标记:类型或语言(或省略两者)?
- C++杂记之this指针
- 《坐热板凳》第五次作业:团队项目需求改进与系统设计
- Oracle ORA-01033: ORACLE initialization or shutdown in progress 错误解决办法Windows版(手贱强制重启电脑的后果)...
- arduino相关知识点思维导图合集
- Axure RP 8--成绩管理页面原型图
- 记2015年的腾讯校招经历——状态篇
- 超级签补充-IOS描述文件mobileconfig的签名认证
- 第十一届蓝桥杯 b组
- 孟子《生于忧患,死于安乐》日:“故天将降大任于斯人也,必先苦其心志,劳其筋骨,饿其体肤,空乏其身,行拂乱其所为,所以动心忍性,曾益其所不能。”...
- 华为路由器命令手册_用数据说话,华为路由Q2 Pro与网件R7800对比测评
- [蓝奏云] 洛达AB153x_UT检测工具
- Linux 【Linux下VI语法】
- OpenStack Victoria版——6.2计算节点-Nova计算服务组件
热门文章
- colspan(colspan=2)
- Halcon 二维码识别QR
- 移动磁盘由于IO设备错误,无法运行此项请求文件怎样找到
- MFBF:作业反冲-----报工过账
- 工作组计算机无法打开电子表格,excel可以共享吗怎么设置共享
- 网上常见的简单投票代码
- stylus在vue中的安装及使用
- 几款优秀的 Windows 虚拟串口模拟器
- org.eclipse.ui.part.FileEditorInput cannot be cast to com.genuitec.eclipse.code.ui.welcome.editors.C
- 婴幼儿护理基本知识-------一洲服务