Indent

This page was migrated from a javaranch.com.jsp




Java Programming Style Guide


1 - Formatting

1.1 - Indentation


Matching braces are always in the same column as their construct.
All indenting is done with spaces, not tabs. All indents are four spaces.

Reasoning: All programs work well with spaces. Most programs will mix tabs and spaces so that some lines are indented with spaces and some with tabs. If your tabbing is set to four and you share a file with someone that has tabbing set to 8, everything comes out goofy.

Example:

void foo() {    while ( bar > 0 )    {        System.out.println();        bar--;    }    if ( oatmeal == tasty )    {        System.out.println("Oatmeal is good and good for you");    }    else if ( oatmeal == yak )    {        System.out.println("Oatmeal tastes like sawdust");    }    else    {        System.out.println("tell me pleeze what iz dis 'oatmeal'");    }    switch( suckFactor )    {        case 1:            System.out.println("This sucks");            break;        case 2:            System.out.println("This really sucks");            break;        case 3:            System.out.println("This seriously sucks");            break;        default:            System.out.println("whatever");            break;    } }


All if, while and for statements must use braces even if they control just one statement.

Reasoning: Consistency is easier to read. Plus, less editing is involved if lines of code are added or removed.

if ( superHero == theTick ) System.out.println("Spoon!");  // NO! if ( superHero == theTick )  // YES! {    System.out.println("Spoon!"); }