BT

如何利用碎片时间提升技术认知与能力? 点击获取答案

Google的Java编码规范

| 作者 Bienvenido David 关注 0 他的粉丝 ,译者 梅雪松 关注 0 他的粉丝 发布于 2014年2月13日. 估计阅读时间: 2 分钟 | Google、Facebook、Pinterest、阿里、腾讯 等顶尖技术团队的上百个可供参考的架构实例!

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等等。

原文英文链接:Google's Java Coding Standards


感谢姚琪琳对本文的审校。

给InfoQ中文站投稿或者参与内容翻译工作,请邮件至editors@cn.infoq.com。也欢迎大家通过新浪微博(@InfoQ)或者腾讯微博(@InfoQ)关注我们,并与我们的编辑和其他读者朋友交流。

评价本文

专业度
风格

您好,朋友!

您需要 注册一个InfoQ账号 或者 才能进行评论。在您完成注册后还需要进行一些设置。

获得来自InfoQ的更多体验。

告诉我们您的想法

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

不错 by 千手 白少

编码规范,对效率也有提升

不错 by 千手 白少

编码规范,对效率也有提升

学习了 by 赵 立超

团队中要有一致的编码规范和风格。

中文版 by Alexia Wang

早就有人发布中文版的啦,www.cnblogs.com/lanxuezaipiao/p/3534447.html

Re: 中文版 by Shi Lei

谢谢分享!

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

5 讨论

登陆InfoQ,与你最关心的话题互动。


找回密码....

Follow

关注你最喜爱的话题和作者

快速浏览网站内你所感兴趣话题的精选内容。

Like

内容自由定制

选择想要阅读的主题和喜爱的作者定制自己的新闻源。

Notifications

获取更新

设置通知机制以获取内容更新对您而言是否重要

BT