Jindent - Java Source Code Formatter http://www.jindent.com
 

previous topic  Previous:  Switch-Case Next:  Try/Catch   next topic

title
5.6.2.3.7 Enum

Brace style for enumeration declarations

Brace style for enumeration declarations

Left brace { new line


Controls whether the left brace of an enumeration declaration appears on a new line or not.


Setting left brace to a new line:

enum Season {                           
    ...                                 


Do not set left brace to a new line:

enum Season {                           
    ...                                 



Right brace } new line


Since right braces of enumeration declarations always appear in a new line this setting has no effect in this case.



Indent left brace {


Specifies the indentation size of left braces.


Setting left brace to a new line and using an indentation size of 4:

enum·Season                             
····{                                   
····...                                 


Setting left brace to a new line and using an indentation size of 0:

enum·Season                             
{                                       
    ...                                 


Do not set left brace to a new line and use indentation size of 1:

enum·Season·{                           
    ...                                 


Do not set left brace to a new line and use indentation size of 0:

enum·Season{                            
    ...                                 



Indent right brace }


Specifies the indentation size of right braces.


Left brace is on a new line and set indentation size of 4 for left and right braces:

enum·Season                             
····{                                   
····...                                 
····}                                   


Left brace is on a new line and set indentation size of 0 for left and right braces:

enum·Season                             
{                                       
····...                                 
}                                       



Indent after right brace }


Since no tokens (except comments) can appear directly after right braces of enumeration declarations this setting has no effect in this case.



Cuddle braces of empty blocks {}


Specifies how to format braces of empty enumeration blocks.


Cuddle braces of empty blocks:

enum Season {}                          


Do not cuddle braces of empty blocks:

enum Season {                           
}                                       



Indent cuddled braces {}


Controls the indentation size of cuddled braces.


Cuddle braces of empty blocks and use an indentation of 0:

enum·Season{}                           


Cuddle braces of empty blocks and use an indentation of 1:

enum·Season·{}                          



Prohibit blank lines after left brace {


Prohibits blank lines directly after a left brace of enumeration blocks.

Some code conventions require a blank line before each comment.
Such a formatting looks proper if the comment, for instance, appears between two enumeration elements.
But if a comment follows directly after a left brace of enumeration blocks an unecessary gap can appear.


Left brace of enumeration block is set to a new line using an indentation size of 0.
Additionally a blank line shall be inserted before comments:

enum Season                             
{                                       
                                       
    // comment with a preceding blank line
    WINTER, SPRING, SUMMER, FALL;       
                                       
    // another comment                  
    ...                                 
}                                       


In the example above the left brace and blank line before the comment seem to create an unnecessary gap.
To avoid such a gap just prohibit blank lines after left braces:

enum Season                             
{                                       
    // comment with a preceding blank line
    WINTER, SPRING, SUMMER, FALL;       
                                       
    // another comment                  
    ...                                 
}                                       

Now the blank line before the first comment disappeared and closed the gap, but all other comments still contain the expected blank line as usual.
Of course this works for all kind of blank lines and not only for blank lines before comments.

See also... See also: Jindent - Settings - Formatter - C / C++ - Blank Lines - Comments , Jindent - Settings - Formatter - C / C++ - Blank Lines




If number of lines in body is at least ... then insert blank line after {


Inserts an extra blank line after left braces of enumerations containing a certain number of lines in their bodies.

Code conventions which prefer the K&R brace style (also known as Kernal, Cpp or Sun Style: do NOT put left brace to a new line) can run into a specific issue regarding readability of source code.


Let's assume the following source code example is formatted in a typical K&R brace style:

enum Season {                           
    WINTER,SPRING,SUMMER,FALL;          
}                                       
                                       
enum Color {                            
    RED,GREEN,BLUE,  // comment         
    ORANGE, BLACK,   // comment         
    BROWN, MAGENTA                      
}                                       

In this case formatting of enumeration Season looks fine, but enumeration Color seems to be formatted too close: The enumeration head enum Color { and the first elements declaration RED,GREEN,BLUE; are connected too close and could cause confusion.
To avoid a too close formatting for specific enumerations use setting "If number of lines in body is at least ... then insert blank line after {" to insert an extra blank line before the first enumeration element.


The same example as above, but now using setting "If number of lines in body is at least ... then insert blank line after {" with a value of 2.


enum Season {                           
    WINTER,SPRING,SUMMER,FALL;          
}                                       
                                       
enum Color {                            
                                       
    RED,GREEN,BLUE,  // comment         
    ORANGE, BLACK,   // comment         
    BROWN, MAGENTA                      
}                                       

Now formatting of enumeration Color seems to be much clearer and enumeration Season is still formatted as before.
This setting counts the lines of code in every enumeration body and if at least 2 lines are counted then an extra blank line is inserted after the left brace of enumeration head.
With this setting small enumerations can be kept compact, but enumerations with an extended body are formatted more spacious and clearer.


Using value 0:

enum Season {                           
                                       
    WINTER,SPRING,SUMMER,FALL;          
}                                       
                                       
enum Color {                            
                                       
    RED,GREEN,BLUE,  // comment         
    ORANGE, BLACK,   // comment         
    BROWN, MAGENTA                      
}                                       

And all enumerations are formatted more spacious.

To turn this setting completely off just choose value infinite.



If number of lines in body is at least ... then insert blank line before }


Inserts an extra blank line before right braces of enumerations containing a certain number of lines in their bodies.

This setting works exactly in the same way as "If number of lines in body is at least ... then insert blank line after {", but now the extra blank line will be inserted at the end of enumeration bodies.


Let's assume "If number of lines in body is at least ... then insert blank line after {" is set to 2 and "If number of lines in body is at least ... then insert blank line before }" is set to 2 too:

enum Season {                           
    WINTER,SPRING,SUMMER,FALL;          
}                                       
                                       
enum Color {                            
                                       
    RED,GREEN,BLUE,  // comment         
    ORANGE, BLACK,   // comment         
    BROWN, MAGENTA                      
                                       
}                                       

This additional setting creates an even more spacious formatting style.



Do not insert blank line before single left brace


Since right braces of enumeration declarations always appear in a single way (in a new line) this setting should be unchecked to avoid confusion.



See also... See also: Jindent - Settings - Formatter - C / C++ - Braces Style - Presets