微信号:infoqchina

介绍:有内容的技术社区媒体

Google的Java编码规范

2014-02-13 20:48 InfoQ

Google最近发布了一份完整的Java编码规范。规范的内容包括一些切实可行的硬性规定。Google内部均遵守此规范。该规范不仅涵盖了代码格式,还包括其他类型的约定和编码标准。


该规范主要分为6大部分:源文件基本规范、源文件结构、代码格式、命名、编程实践和Javadoc。源文件基本规范说明文件名、文件编码、空格和特殊字符等规范要求。源文件结构说明许可信息、package和import声明、类成员顺序等规范要求。代码格式用于说明源代码中大括号、缩进、换行、空格、括号、枚举、数组、switch语句、注解、注释和修饰符等格式要求。命名说明了标识符(包、类、方法、常量、属性、局部变量和类变量)的命名规范和驼峰大小写定义。编程实践说明@Override、异常、静态成员和终结器的用法。Javadoc说明哪些地方需要Javadoc,以及它的格式要求。


以下是从规范中摘录的一些内容:

  • import中不能有通配符。

  • 重载方法应该放在一起连续出现。

  • 即使代码块中没有内容,或者只有一行代码,也必须使用大括号。

  • 2空格缩进。

  • 列宽是80或100个字符。

  • 不能使用类似C语言的数组变量声明。

  • switch语句中,必须包含default语句。

  • 修饰符的顺序应按照Java语言规范推荐的顺序。

  • 常量命名应使用CONSTANT_CASE格式(译注:所有字母大写,单词使用下划线分隔)。注意,所有常量都必须是static final成员,但并不是所有的static final成员都是常量。


更多内容请阅读Google Java Style。Oracle也提供了官方的Java语言编码规范。Google还提供了其它语言的代码风格指南,包括C++、Objective-C、Python、Shell、HTML/CSS、JavaScript和Lisp等等。


***********************************

本文来自InfoQ微信公众账号:infoqchina

1、回复“今日新闻”,查看今天更新的新闻;

2、回复“今日英文”,查看今天英文站的更新;

3、回复“文章 +关键词”,搜索关键词相关内容;

4、回复“QCon”,了解QCon大会相关信息;

5、回复“活动”,了解最近InfoQ组织的线下沙龙;

6、回复“架构师”,获取《架构师》下载地址;

7、回复“投稿”,了解投稿和加入编辑团队的流程。

***********************************

 
InfoQ 更多文章 Facebook如何实现PB级别数据库自动化备份 学术派Google软件工程师Matt Welsh谈移动开发趋势 Spotify为什么要使用一些“无聊”的技术? 妹纸们放假了,汉纸们做啥? 大多数重构可以避免
猜您喜欢 达内9月java免费训练营强势来袭,送中秋好礼咯! 知识点归纳(4) 覆盖equals时请遵守通用约定 Ctrip VDesktop 5000 庆祝 & 答谢会 JSR133并发基础规范解析