What is Google Java Style Guide?

Etymology and Corporate Code Standards

The Google Java Style Guide is a set of rules developed by Google, one of the world's largest technology companies, to ensure that its tens of thousands of engineers can work seamlessly on the same codebase. Since its initial publication, it has become a de facto standard not only within Google but also in the global open-source ecosystem and the enterprise software world.

The guide outlines all the formal and structural boundaries a Java file should have, from source file structure to package declarations, indentation rules to class and variable naming conventions, and Javadoc formatting to error handling. In a software project, having everyone add spaces or open brackets according to their own personal taste leads to unnecessary debates and wasted time during code reviews. The Google Java Style Guide eliminates these subjective discussions, allowing developers to focus solely on business logic.

Technical Depth and Ground Rules

Source File Structure and Indentation: Files are always encoded in UTF-8. Two (2) spaces are used for indentation instead of tabs. Line length is limited to 100 characters; braces are placed at the end of the line according to the K&R style.
Import Standards: Wildcard imports (import java.util.*;) are prohibited. Each class must be imported explicitly and sorted alphabetically.
Naming Conventions: Classes are named using UpperCamelCase, methods and variables using lowerCamelCase, and constants using CONSTANT_CASE. In abbreviations, only the first letter is kept uppercase (XmlHttpRequest).
Defensive Programming and Automation: @Override is mandatory for overridden methods. Empty catch blocks are prohibited. Rules are automatically enforced in the CI/CD pipeline using google-java-format, Checkstyle, and Spotless plugins.
Javadoc and Comment Standards: Writing Javadoc descriptions for public classes is mandatory; @param, @return, and @throws tags must be filled out completely.

Sociological Dimension: Readability and Team Productivity

Research in software engineering shows that a developer spends more than 80 percent of their time not writing new code, but reading existing code. Therefore, readability is far more valuable than ease of writing.

The Google Java Style Guide allows developers to set aside personal ego and aesthetic concerns regarding code and prioritize the team's collective productivity. For projects that accept external contributions (pull requests) in the open-source world, this guide is a universal agreement document that ensures contributors can adapt to the project effortlessly.

Common Mistakes and Misconceptions

Trying to Format Manually: Instead of counting spaces one by one, the google-java-format plugin should be installed in the IDE and auto-save formatting should be enabled.
Disabling Checkstyle Rules: Disabling style checks in CI/CD when the process is tight increases technical debt.
Overusing Comment Lines: The code should aim to be self-explanatory; meaningless comments should not be written for obvious getter/setter methods.

Questions and answers

Related terms