Code formatting rules for Android Studio
- Based on googles java code style (https://git.io/v5XuB)
- No star imports except for testing libraries
- Increase the line length to 140
android:id
afterxmlns
declaration in XML layouts- Keep lifecycle methods together
- Keep getters and setters together
- Advanced code Arrangement rules for Java (Sort methods alphabetically (a-z) and by visibility (
public
-private
))- Inner classes (classes, interfaces, enums)
- Fields (grouped by visibility, a-z)
- public static methods (a-z)
- Constructors
- Android Lifecycle methods in correct order
- Methods (grouped by visibility, a-z)
- static methods (grouped by visibility (except public), a-z)
Just run the install
script.
It will automatically copy the latest Code Style to each existing AndroidStudio
and AndroidStudioPreview
version you have installed.
- Copy the
codestyle.xml
into (MacOS)~/Library/Preferences/AndroidStudio{VERSION}/codestyles/
or (Linux)~/.AndroidStudio{VERSION}/config/codestyles/
- Restart AndroidStudio
- Select the codestyle scheme via
Preferences --> Editor --> Code Style
.
The codestyle will be enabled/used for all projects that are used with AndroidStudio!
If the codestyle is added to the git repository and IntelliJ is configured accordingly each project can have it's own style.
- Install the
codestyle.xml
locally (see above) - Restart AndroidStudio
- In AndroidStudio, go to
Preferences --> Code style
- Open the scheme manager by clicking on
Manage...
- Select the code style and click
Copy to project
- In the scheme drop down select
Project
Finally add the code style to the git repository:
git add -f .idea/codeStyleSettings.xml
Taken from passy's excellent blog post which you can find here
With 3 simple steps you can reorder and reformat your code automatically with ⌘ + S. That shortcut you are used to press constantly although you know Android Studio automatically saves all files for you. Give ⌘ + S a different meaning:
Make sure a Java source file has focus (or you can’t record all steps)
- Select Edit > Macros > Start Macro Recording
- Select Code > Optimize Imports
- Select Code > Reformat Code
- Select Code > Rearrange Code
- Select File > Save All
- Select Edit > Macros > Stop Macro Recording and give it a name (for example OptimizeImportsReformatRearrangeSave)
Go to Preferences > Keymap
- Find the Macro section
- Add ⌘ + S shortcut for the new macro
Alternatively you can reformat code with ⌥+⌘+L . When you select parts of your code, only those get reformatted. This doesn’t reorder your code or changes imports. It's best to use when touching code which doesn’t have a code style.
To contribute just change the code style locally to your needs. Then you can create a PR to this repository.
The PR should always contain:
- Some information what have changed.
- A updated
codestyle.xml
.