写点什么

Google 的 Java 编码规范

  • 2014-02-12
  • 本文字数:798 字

    阅读完需:约 3 分钟

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 )关注我们,并与我们的编辑和其他读者朋友交流。

2014-02-12 02:4923695

评论

发布
暂无评论
发现更多内容

全文!马云对数字时代全球化的全新解读

CECBC

全球化 数字时代

太牛了,这份神仙级面试笔记把所有 Java 知识面试题都详解出来了

Java架构之路

Java 程序员 面试 编程语言

2020HC大会上,这群人在讨论云原生…

华为云开发者联盟

华为 华为云 大会

极光无限:用AI赋能安全 解决安全行业人才紧缺难题

风向标

人工智能

深入剖析 | Java15语法特性

九叔(高翔龙)

Java 架构 Java 分布式 java15新特性

从三个产业侧影,打开万物智能的应用之匙

脑极体

不是我不小心

escray

Java ruby ruby-on-rails 面试 面经

LeetCode题解:242. 有效的字母异位词,数组排序,JavaScript,详细注释

Lee Chen

大前端 LeetCode

架构师训练营 - 作业 - 第二周

Max2012

数据库选型入门必读:如何在眼花缭乱的产品中挑出最适合业务的?

华为云开发者联盟

数据库 数据库选择 关系型

甲方日常 25

句子

生活 随笔杂谈 日常

代码重构 - 课后作业

Nick~毓

一个草根的日常杂碎(9月29日)

刘新吾

随笔杂谈 生活记录 社会百态

中秋佳节,程序员教你AI三步成诗,秒变“李白”

华为云开发者联盟

AI 中秋

软件架构(2)-框架设计

Zeke

极客大学架构师训练营

重塑产业+价值共识,区块链助力供应链金融数字化

CECBC

区块链 供应链物链

关于 UML 类图

西贝

UML 图表

技术解读丨目标检测之RepPoints系列算法

华为云开发者联盟

算法 神经 目标检查

区块链掀起全民创业热潮!数字资产是未来全球最具前景和价值的!

CECBC

区块链 数字货币

GitHub上标星68k,基于SpringBoot+Netty分布式开源的即时通讯系统项目

Java架构之路

Java 程序员 编程语言 Netty 项目实战

谈谈测试

BigBang!

测试的价值 测试文化 测试落地

架构师训练营 1 期第 3 周:代码重构 - 作业

piercebn

极客大学架构师训练营

开源=免费?

Philips

开源 开源社区

一周信创舆情观察(9.21~9.27)

统小信uos

第三课代码重构课后作业

Geek_michael

极客大学架构师训练营

阿里内部超流行的“SpringBoot+ 微服务指南”,理论与实战双管齐下

Java架构之路

Java 程序员 微服务 Spring Boot 编程语言

单例模式

knight

国内上市进程或将提速!百度宣布小度科技独立融资

脑极体

在vue2中使用ts

正经工程师

typescript vue.js

第三周学习代码重构总结

三板斧

极客大学架构师训练营

上手深度学习之前,我们先聊聊“数学”

华为云开发者联盟

神经网络 学习 数学

Google的Java编码规范_Java_Bienvenido David_InfoQ精选文章