DroidsOnRoids/android-style-guide

Droids On Roids: Android Code Style

Config

Android Studio

Every DOR Android team member should use this code formatting style in Android Studio:

dor-android-studio-code-style.xml

This ensures formatting consistency across projects. It also makes code review more pleasant, as it reduces time spent on checking things like missing spaces, wrong indents, etc.

SonarQube

SonarQube is a code inspection tool that helps you:

• avoid common Java mistakes
• follow code style conventions
• get rid of unwanted bugs

It won't break your builds, but it will judge you and your code by commenting your commits uploaded for review.

Local config

You can also run SonarQube locally in your project without waiting for a remote build to complete. See the official guide for reference:

Analyzing with SonarQube Scanner for Gradle

SonarLint

SonarLint is an Android Studio plugin. It can connect to an external SonarQube server and analyze code on-the-fly, similar to the built-in default Lint functionality.

I think you can handle the plugin config within Android Studio.

If it doesn't work out of the box, you'll have to use a different JDK with JCE unlimited strength policy:

• install the newest JDK

  Homebrew: brew install Caskroom/cask/java.

• install JCE Unlimited Strength Policy

  brew install Caskroom/cask/jce-unlimited-strength-policy

• select the JDK version used by Android Studio

  Go to ~/Library/Preferences/AndroidStudio2.3/studio.jdk (if it doesn't exist, just create a new one).

  Add the following line /Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk.

  Make sure to use change use your current version numbers.

• restart Android Studio

Code style

There is no strict code style that you have to follow. Instead, please refer to some good existing ones:

• Google Java style guide

  Solid general Java style to follow.

• Ribot Android guidelines

  Good Java and Android-specific practices - apart from Hungarian notation.

• Buffer Android guidelines

  Similar to Ribot's.

• A successful XML naming convention

  Good convention for naming Android resource files.

The only rule you should go by is to be consistent within a project.

Specific topics

Kotlin

Code style

Please refer to Kotlin's website: Kotlin Coding Conventions

XML

Kotlin Android Extensions automatically bind XML-defined views. This allows us to call them through synthetic properties without manually using findViewById() or Butterknife.

Considering that, use lowerCamelCase when naming views in XML files (in contrast to snake_case in Java projects).

Tests

When naming tests, use backticked method names for better readability:

`should return negative one when argument is null`()

Methods with braces or as assignment?

If the method body is simple or short enough to fit in the same line, use the assignment operator ( = ), otherwise use braces ( { } ).

Loops or streams?

Consider streams when iterating (instead of typical for loops), as they can often make the code more concise and readable.

Hungarian notation

Hungarian notation (private/static fields starting with m/s) is generally not recommended. Here's a good write-up on why not:

Just Say mNo to Hungarian Notation (Jake Wharton)

If you wish to easily remove it from an existing project, see this article about the Structural Search and Replace feature of Android Studio:

Android Studio Like a Boss (Realm.io)

RxJava/Stream chains

Those can get pretty ugly sometimes.

If possible, avoid deep nesting in RxJava/Stream chains. Instead, try to refactor operator arguments into separate methods. A good rule of thumb for clean and readable chains: one line = one operator.