Code Style. Java
for macOS
Ctrl+Alt+S
Use this page to configure formatting options for Java files. View the result in the Preview pane on the right.
On this page:
- Tabs and Indents
- Spaces
- Wrapping and braces
- Blank lines
- JavaDoc
- Arrangement
- Imports
- Code Generation
- Java EE Names
Tabs and Indents
Item | Description |
---|---|
Use tab character |
|
Smart tabs |
The Smart Tabs check box is available if the Use Tab Character check box is selected. |
Tab size | In this text box, specify the number of spaces included in a tab. |
Indent | In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted for each indent level. |
Keep indents on empty lines | If this check box is selected, then IntelliJ IDEA will keep indents on the empty lines as if they contained some code. If this check box is not selected, IntelliJ IDEA will delete the tab characters and spaces. |
Label indent | In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted at the next line before a label statement. |
Absolute label indent | If this check box is selected, label indentation is counted as an absolute number of spaces. Otherwise, label indentation is counted relative to previous indent levels. |
Do not indent top level class members | Select this check box to have top level class members located at the class declaration indentation level. |
Use indents relative to expression start | Use this check box to switch between the two possible indentation behaviors:
|
Spaces
Use this tab to specify where you want spaces in your code. To have IntelliJ IDEA automatically insert a space at a location, select the check box next to this location in the list. The results are displayed in the Preview pane.
Wrapping and braces
In this tab, customize the code style options, which IntelliJ IDEA will apply on reformatting the source code. The left-hand pane contains the list of exceptions (Keep when reformatting), and placement and alignment options for the various code constructs (lists, statements, operations, annotations, etc.) The right-hand pane shows preview.
Alignment takes precedence over indentation options.
Right Margin (columns)
Use Right Margin field to specify a margin space required on the right side of an element. If you select Default option then a value of the right margin from the global settings is used.
Wrap on typing
Use Wrap on typing settings to specify how the edited text is fitted in the specified Right margin. You can select one the following options:
- Default - in this case IntelliJ IDEA uses the Wrap on typing option that is specified in the global settings.
- Yes - in this case IntelliJ IDEA uses the value specified in the Right Margin field.
- No - in this case this option is switched off and a line can exceed the value specified in the right margin.
Keep when reformatting
Use the check boxes to configure exceptions that IntelliJ IDEA will make when reformatting the source code. For example, by default, the Line breaks check box is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks check box before you reformat the source code.
Wrapping options
The wrapping style applies to the various code constructs, specified in the left-hand pane (for example, method call arguments, or assignment statements).
Item | Description |
---|---|
Wrapping style | From this drop-down list, select the desired wrapping style:
|
Alignment options
Item | Description |
---|---|
Align when multiline | If this check box is selected, a code construct starts at the same column on each next line. Otherwise, the position of a code construct is determined by the current indentation level. |
<character(s)> on next line | Select this check box to have the specified character or characters moved to the next line when the lines are wrapped. |
'else' on new line | Use this check box to have the corresponding statements or characters moved to the next line. |
New line after <character> | Select this check box to have the code after the specified character moved to a new line. |
Special else if treatment | If this check box is selected, else if statements are located in the same line. Otherwise, |
Indent case branches | If this check box is selected, the case statement is located at the corresponding indent level. Otherwise, case statement is placed at the same indent level with switch . |
Braces placement options
Item | Description |
---|---|
Braces placement style | Use this drop-down list to specify the position of the opening brace in class declarations, method declarations, and other types of declarations. The available options are:
|
Force braces | From this drop-down list, choose the braces introduction method for if , for , while , and do () while statements. The available options are: |
Blank lines
Use this tab to define where and how many blank lines you want IntelliJ IDEA to retain and insert in your code after reformatting. For each type of location, specify the number of blank lines to be inserted. The results are displayed in the Preview pane.
Item | Description |
---|---|
Keep Maximum Blank Lines | In this area, specify the number of blank lines to be kept after reformatting in the specified locations. |
Minimum Blank Lines | In the text boxes in this area, specify the number of blank lines to be present in the specified locations. These settings do not influence the number of blank lines before the first and after the last item. |
JavaDoc
Item | Description |
---|---|
Alignment | In this area, define how JavaDoc comments should be aligned.
|
Blank Lines | In this area, define where blank lines should be inserted in JavaDoc comments.
|
Invalid Tags | In this area, define whether invalid tags should be preserved or not.
|
Other | In this area, specify additional formatting options for JavaDoc comments.
|
Arrangement
This tab lets you define a set of rules that rearranges your code according to your preferences.
Item | Description |
---|---|
Grouping Rules | Use this area to set the grouping rules.
|
Matching rules | Use this area to define elements order as a list of rules, where every rule has a set of matches such as modifier or type.
|
Empty rule | Use this area to create a new matching rule or edit an existing one. You can select from the following filters:
|
This icon appears when you select Order by Name from the Order list. The icon indicates that the items in this rule are sorted alphabetically. |
Imports
This table lists actions to be performed when imports are optimized.
Item | Description |
---|---|
General | In this area, configure general import options. Options:
|
JSP Imports Layout | In this area, configure how JSP import statements should be organized in your code. The introduced changes are displayed in the Preview pane below. Options:
|
Packages to Use Import with '*' | In this area, configure a list of packages and classes to be always imported completely. Options:
|
Import Layout | In this area, configure how import statements should be organized in your code. You can set up certain classes to be positioned first, or last, or one after another. Imported classes will be grouped as per their packages and sorted alphabetically within a package. Options:
|
Code Generation
Item | Description |
---|---|
Naming | Options:
|
Final Modifier | Options:
|
Comment Code | Options:
|
Order of Members | Specify the necessary order:
|
Other Controls | Select the necessary options:
|
Java EE Names
Use this tab to specify prefixes and suffixes for the names of bean classes, bean interfaces, <ejb-name>
tags, servlets, filters, and listeners. These prefixes and suffixes will by default appear in the corresponding fields of the New Bean, New Servlet, New Filter, and New Listener dialog boxes. For entity beans, you can also specify the default primary key class that appears in the Create CMP Field dialog box.
Item | Description |
---|---|
Entity Bean | Use the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Entity Bean components:
|
Session Bean | Use the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Session Bean components:
|
Message Driven Bean | Use the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Message Driven Bean components:
|
Servlet | Use the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Servlets:
|
Filter | Use the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Filters:
|
Listener | In this area, specify the prefix and suffix to be used in the names of listener classes. |