# Code Style. Groovy

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com.cn/en-us/help/idea/2026.3/llms.txt).

> **TL;DR**
> `File | Settings | Editor | Code Style | Groovy` for Windows and Linux
>
>
>
> `IntelliJ IDEA | Settings | Editor | Code Style | Groovy` for macOS
>
>
>
> `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) ![the Settings icon](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.settings.svg)

Use this page to configure formatting  options for Groovy files. When you change these settings, the Preview pane shows how this will affect your code.

## Tabs and Indents

| Item | Description |
| --- | --- |
|  Use tab character |    Use the `Tab` (Windows), `⇥` (macOS), `⇥` (IntelliJ IDEA Classic (macOS)), `⇥` (macOS System Shortcuts), `Tab` (XWin), `Tab` (GNOME), `Tab` (KDE), `Tab` (Emacs), `Tab` (Sublime Text), `⇥` (Sublime Text (macOS)), `Tab` (Visual Studio), `⇥` (Visual Studio (macOS)), `Tab` (NetBeans), `Tab` (Eclipse), `⇥` (Eclipse (macOS)) key for indentation. When the checkbox is cleared, IntelliJ IDEA uses spaces instead of tabs.       |
|  Smart tabs  |      * If this checkbox is selected, the indentation for nested code blocks will use tabs and spaces as needed, while alignment indentation will use only spaces.    * If this checkbox is cleared, only tabs are used. This means that a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment.     The Smart tabs checkbox is available if the Use tab character option is enabled.       |
|  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.   |
|  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. |

## 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](reformat-and-rearrange-code.html). 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.

> **Tip:**
> 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](settings-code-style.html#rightMargin) 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](settings-code-style.html#wrapOnTyping).

* 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](reformat-and-rearrange-code.html).

### 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:        * Do not wrap: when this option is selected, no special wrapping style is applied. With this option selected, the nested alignment and braces settings are ignored.    * Wrap if long: select this option to have lines going beyond the right margin wrapped with proper indentation.    * Wrap always: select this option to have all elements in lists wrapped, so that there is one element per line with proper indentation.    * Chop down if long: select this option to have elements in lists that go beyond the right margin wrapped, so that there is one element per line with proper indentation.    |

### 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.  |
| `<character(s)>` on next line | 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 `<character>`  | 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, `else if` statements are located in the same line.       Otherwise, `else if` statements are moved to the next line to the corresponding indent level.    |
| Indent 'case' branches |  If this checkbox 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 list to specify the position of the opening brace in class declarations, method declarations,  and other types of declarations. The available options are:        * End of line: select this option to have the opening brace placed at the declaration line end.    * Next line if wrapped: select this option to have the opening brace placed at the beginning of the line after the multiline declaration line.    * Next line: select this option to have the opening brace placed at the beginning of the line after the declaration line.    * Next line shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level.    * Next line, each shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level, and have the next line shifted to the next indent level as well.    |
|  Force braces |    From  this  list, choose the braces introduction method for `if`, `for`, `while`, and `do () while` statements. The available options are:         * Do not force : select this option to suppress introducing braces automatically.    * When multiline : select this option to have braces introduced automatically if a statement occupies more than one line. Note that IntelliJ IDEA analyzes the number of lines in the entire statement but not only its condition. IntelliJ IDEA will insert braces automatically:    * Always : select this checkbox to have braces always introduced automatically.     |

## 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 keep after reformatting in the specified locations.   |
|   Minimum blank lines   |     In this area, specify the minimum number of blank lines to be present in the specified locations.       > **Warning:** > These settings do not influence the number of blank lines before the first and after the last item.    |

## Imports

Use this tab to configure how IntelliJ IDEA should add and organize import statements in your files. IntelliJ IDEA uses these settings when it [adds an import statement automatically](creating-and-optimizing-imports.html), when you [optimize imports](creating-and-optimizing-imports.html#optimize-imports), and when you [reformat code](reformat-and-rearrange-code.html).

### General

Use these settings to configure how IntelliJ IDEA should handle imports from other packages.

| Item | Description |
| --- | --- |
|  Use single class import  |     When you use a class from another package, import only the class instead of its whole package.      Not selected:  ```JAVA import java.time.*; ```   Selected:  ```JAVA import java.time.Duration; import java.time.LocalDate; import java.time.LocalTime; ```      > **Note:** > The limit in [Class count to use import with '*'](#import-class-limit) still applies when this option is selected.    |
|  Use fully qualified class names  |     When you use a class from another package, insert the fully qualified class name inline instead of adding an import statement.      Not selected:  ```JAVA import java.time.LocalDate;  LocalDate date = LocalDate.now(); ```   Selected:  ```JAVA java.time.LocalDate date = java.time.LocalDate.now(); ```     |
|  Insert imports for inner classes  |     When you use an inner class, import the inner class instead of its outer class and refer to it by its simple name.      Not selected:  ```JAVA import com.shop.Order;  Order.Item item; ```   Selected:  ```JAVA import com.shop.Order.Item;  Item item; ```      |
|   Use fully qualified class names in javadoc  |     When you refer to a class from another package in a [GroovyDoc](https://groovy-lang.org/groovydoc.html) comment, use its fully qualified name instead of adding an import statement and using its simple name.      Not selected:  ```GROOVY import java.time.LocalDate;  /**  * Returns the {@link LocalDate} of the order.  */ ```   Selected:  ```GROOVY /**  * Returns the {@link java.time.LocalDate} of the order.  */ ```     |
|  Class count to use import with '*'  |     Specify the limit for single-type imports from the same package. When a file reaches this limit, the IDE replaces these imports with a wildcard package import.      Below the limit of 5:  ```JAVA import java.time.Duration; import java.time.Instant; import java.time.LocalDate; import java.time.LocalTime; ```   Limit of 5 reached:  ```JAVA import java.time.*; ```     |
|  Names count to use static import with '*'  |     Specify the limit for static imports from the same class. When a file reaches this limit, the IDE replaces these imports with a wildcard import of all static members.      Below the limit of 3:  ```JAVA import static java.lang.Math.abs; import static java.lang.Math.max; ```   Limit of 3 reached:  ```JAVA import static java.lang.Math.*; ```     |

### Packages to Use Import with '*'

Use this table to specify packages and classes for which the IDE should always use a wildcard import (ending with `*`). You can use it in two ways:

* To import a whole package whenever you use one of its classes (instead of only that class), add the package name. To apply this rule to its subpackages too, select With Subpackages. Here is an example where `java.time` is added to the table: Not selected: ```JAVA import java.time.*; import java.time.format.DateTimeFormatter; ``` Selected: ```JAVA import java.time.*; import java.time.format.*; ``` > **Note:** > This overrides the [Use single class import](#use-single-class-import) and [Class count to use import with '*'](#import-class-limit) settings.

* To import all static members of a class whenever you use one of its static members (instead of only that member), add the class name and select Static. Here is an example where `java.util.Collections` is added to the table: Not selected: ```JAVA import static java.util.Collections.emptyList; ``` Selected: ```JAVA import static java.util.Collections.*; ``` > **Note:** > This overrides the [Use single class import](#use-single-class-import) and [Names count to use static import with '*'](#import-static-limit) settings.

To add and remove rows, use the icons in the table toolbar.

### Import layout

Use these settings to configure the order, grouping, and line spacing of import statements.

| Item | Description |
| --- | --- |
|  Layout static imports separately  |     When you optimize imports, place static imports in their own groups instead of sorting them with other imports from the same package.      Not selected:  ```JAVA import java.time.Duration; import static java.time.Duration.ofSeconds; import java.time.LocalDate; ```   Selected:  ```JAVA import java.time.Duration; import java.time.LocalDate;  import static java.time.Duration.ofSeconds; ```      > **Note:** > If you clear this option, the IDE removes all static rows from the [Import layout](#import-layout-row) table.    |
|  Import layout  |     Configure the order of import statements in your files and organize them into groups.       The layout is defined at the package level. By default, the position of a package applies to both its wildcard imports and single-type imports. You can change this scope with the following options:        * Static: use this position only for the static imports from this package. Here is an example where `java.time` is added to the top of the default layout: Not selected: ```JAVA import java.time.LocalDate; import java.sql.Connection; import static java.time.temporal.ChronoUnit.DAYS; ``` Selected: ```JAVA import static java.time.temporal.ChronoUnit.DAYS; import java.sql.Connection; import java.time.LocalDate; ``` > **Note:** > This option is only available if [Layout static imports separately](#layout-static-imports-separately) is selected.    * With Subpackages: use this position for imports from both this package and its subpackages. Here is an example where `java.time` is added to the top of the default layout: Not selected: ```JAVA import java.time.LocalDate; import java.sql.Connection; import java.time.format.DateTimeFormatter; ``` Selected: ```JAVA import java.time.LocalDate; import java.time.format.DateTimeFormatter; import java.sql.Connection; ```      To add packages and blank lines, remove them, or change their order, use the icons in the table toolbar.     |

## Code generation

| Item | Description |
| --- | --- |
| Order of Members | Use this area to configure a sorting hierarchy of your code members. You can move the list items up or down using ![Move the list item up](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.moveUp.svg) or ![Move the list item down](https://resources.jetbrains.com.cn/help/img/idea/2026.3/app.expui.general.moveDown.svg) arrow keys. |
| Comment Code |    Use this area to configure code style for generated comments (line `Ctrl+/` (Windows), `⌘ /` (macOS), `⌘ /` (IntelliJ IDEA Classic (macOS)), `⌘ /` (macOS System Shortcuts), `Ctrl+/` (XWin), `Ctrl+/` (GNOME), `Ctrl+/` (KDE), `Alt+;` (Emacs), `Ctrl+/` (Sublime Text), `⌘ /` (Sublime Text (macOS)), `Ctrl+Alt+/` (Visual Studio), `⌘ ⌥ /` (Visual Studio (macOS)), `Ctrl+/` (NetBeans), `Ctrl+/` (Eclipse), `⌘ /` (Eclipse (macOS)) and block `Ctrl+Shift+/` (Windows), `⌘ ⌥ /` (macOS), `⌃ ⇧ /` (IntelliJ IDEA Classic (macOS)), `⌘ ⌥ /` (macOS System Shortcuts), `Ctrl+Shift+/` (XWin), `Ctrl+Shift+/` (GNOME), `Ctrl+Shift+/` (KDE), `Ctrl+Shift+/` (Emacs), `Ctrl+Shift+/` (Sublime Text), `⌘ ⌥ /` (Sublime Text (macOS)), `Ctrl+Shift+/` (Visual Studio), `⌘ ⌃ /` (Visual Studio (macOS)), `Ctrl+Shift+/` (NetBeans), `Ctrl+Shift+/` (Eclipse), `⌘ ⇧ /` (Eclipse (macOS))):       * Line comment at first column: start line comments (`Ctrl+/` (Windows), `⌘ /` (macOS), `⌘ /` (IntelliJ IDEA Classic (macOS)), `⌘ /` (macOS System Shortcuts), `Ctrl+/` (XWin), `Ctrl+/` (GNOME), `Ctrl+/` (KDE), `Alt+;` (Emacs), `Ctrl+/` (Sublime Text), `⌘ /` (Sublime Text (macOS)), `Ctrl+Alt+/` (Visual Studio), `⌘ ⌥ /` (Visual Studio (macOS)), `Ctrl+/` (NetBeans), `Ctrl+/` (Eclipse), `⌘ /` (Eclipse (macOS))) at the first column. If you disable the option, the comments will be aligned with your code.    * Add a space at comment start: insert a space between the line comment character and the first character of the commented line.    * Enforce on reformat: insert a space between a line comment character and the first character of a commented line in existing comments when you're [reformatting your code](reformat-and-rearrange-code.html). Note that the first character has to be an alphanumeric symbol, otherwise the space won't be inserted. For example, the `//&Lorem ipsum` comment will be ignored by the reformatter. This option becomes available when Add a space at comment start is enabled.    * Block comment at first column: start block comments (`Ctrl+Shift+/` (Windows), `⌘ ⌥ /` (macOS), `⌃ ⇧ /` (IntelliJ IDEA Classic (macOS)), `⌘ ⌥ /` (macOS System Shortcuts), `Ctrl+Shift+/` (XWin), `Ctrl+Shift+/` (GNOME), `Ctrl+Shift+/` (KDE), `Ctrl+Shift+/` (Emacs), `Ctrl+Shift+/` (Sublime Text), `⌘ ⌥ /` (Sublime Text (macOS)), `Ctrl+Shift+/` (Visual Studio), `⌘ ⌃ /` (Visual Studio (macOS)), `Ctrl+Shift+/` (NetBeans), `Ctrl+Shift+/` (Eclipse), `⌘ ⇧ /` (Eclipse (macOS))) at the first column. If you disable the option, the comments will be aligned with your code.    * Add spaces around block comments: insert a space between the block comment character and the first character of the commented text.    * Prefer documentation line comments: use the Markdown comment style instead of the traditional style when you insert [Javadoc](javadocs.html) comments with quick actions. > **Note:** > Markdown documentation comments are only available in projects that use Java 23 or later.    |

## Set from...

Click this link to reveal the list of languages to be used as the base for the current language code style. Only the settings that are applicable to the current language are taken. All the other settings are not affected.

This link appears in the upper-right corner of the language-specific code style page, when applicable.

Click Reset to discard changes and return to the initial set of code style settings.

## See also

### Language and Framework-Specific Guidelines

[Groovy](groovy.html)

### Procedures

[Code style schemes](configuring-code-style.html)

