Code Style. Java
Last modified: 10 August 2022File | Settings | Editor | Code Style | Java for Windows and Linux
IntelliJ IDEA | Preferences | Editor | Code Style | Java for macOS
Ctrl+Alt+S
Use this page to configure formatting options for Java files. When you change these settings, the Preview pane shows how this will affect your code.
Tabs and Indents
Item | Description |
---|---|
Use tab character |
|
Smart tabs |
The Smart tabs checkbox is available if the Use tab character checkbox is selected. |
Tab size | In this field, specify the number of spaces included in a tab. |
Indent | In this field, specify the number of spaces to be inserted for each indent level. |
Continuation indent | In this field, specify the number of spaces to be inserted between the elements of an array, in expressions, method declarations and method calls. |
Keep indents on empty lines | If this checkbox is selected, IntelliJ IDEA will keep indents on the empty lines as if they contained some code. If this checkbox is cleared, IntelliJ IDEA will delete the tab characters and spaces. |
Label indent | In this field, specify the number of spaces to be inserted at the next line before a label statement. |
Absolute label indent | If this checkbox 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 checkbox to have top level class members located at the class declaration indentation level. |
Use indents relative to expression start | Use this checkbox 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 checkbox 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, and so on) The right-hand pane shows the preview.
Alignment takes precedence over indentation options.
Hard wrap at
Use the Hard wrap at field to specify a margin space required on the right side of an element. If you select the Default option, then a value of the right margin from the global settings is used.
Wrap on typing
Use the Wrap on typing settings to specify how the edited text is fitted in the specified Hard wrap at:
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.
Visual guides
Use the Visual guides field to specify multiple right margins. You can leave a default value or enter the number of spaces for your margin. If you want to specify several margins, enter numbers separated by comma.
Keep when reformatting
Use the checkboxes to configure exceptions that IntelliJ IDEA will make when reformatting the source code. For example, by default, the Line breaks checkbox is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks checkbox 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, method declaration parameters, or assignment statements).
Item | Description |
---|---|
Wrapping style | From this list, select the desired wrapping style:
|
Alignment options
Item | Description |
---|---|
Align when multiline | If this checkbox 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. |
| Select this checkbox to have the specified character or characters moved to the next line when the lines are wrapped. |
'else' on new line | Use this checkbox to have the corresponding statements or characters moved to the next line. |
New line after | Select this checkbox to have the code after the specified character moved to a new line. |
Special 'else if' treatment | If this checkbox is selected, Otherwise, |
Indent 'case' branches | If this checkbox is selected, the |
Braces placement options
Item | Description |
---|---|
Braces placement style | Use this 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 list, choose the braces introduction method for
|
Chained method calls
Use the following options to format chained method calls and make them easier to read. Note that builder method calls are always wrapped regardless of the settings for chained calls.
Item | Description |
---|---|
Wrap first call | Allow wrapping the first method call in chained methods. |
Align when multiline | Align several method calls. |
Builder methods | Specify comma-separated names (identifiers) of methods that you want to be treated as builder methods. For example: |
Keep builder methods indents | Keep additional indents that you insert manually intact as you reformat code. |
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 this area, specify the number of blank lines to be present in the specified locations.
|
JavaDoc
Item | Description |
---|---|
Alignment | In this area, define the way 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 |
|
Default Visibility | Select the default access level for generated fields and methods. |
Final Modifier | Specify whether you want to generate local variables and parameters with the |
Comment Code | Use this area to configure code style for generated comments (line Ctrl+/ and block Ctrl+Shift+/):
|
Override Method Signature |
|
Lambda Body | If a lambda expression calls an existing method, it is preferable to refer to the method by name using a method reference. These checkboxes affect the Lambda can be replaced with method reference inspection. If enabled, the corresponding lambda expressions will be highlighted as warnings with a relevant quick-fix. If disabled, the code will not be highlighted, but an intention to replace the lambda expression with a method reference will still be available.
|
Thanks for your feedback!