Reformat and rearrange code
GoLand lets you reformat your code according to the requirements you've specified in the Code Style settings.
To access the settings, in the Settings/Preferences dialog (Ctrl+Alt+S) go to .
You can reformat a part of code, the whole file, group of files, a directory, and a module. You can also exclude part of code or some files from the reformatting.
Reformat a code fragment in a file
In the editor, select a code fragment you want to reformat.
- In the main menu, select (Ctrl+Alt+L).
Reformat a file
- Either open your file in the editor and press Ctrl+Shift+Alt+L or in the Project tool window, right-click the file and select .
- In the dialog that opens, if you need, select the following reformatting options:
Optimize imports - select this option if you want to remove unused imports, add missing ones, or organize import statements.
Rearrange entries - select this option if you need to rearrange your code based on the arrangement rules specified in the code style settings.
Clean up code - select this option to run the code cleanup inspections.
Reformat line indents
You can reformat line indents based on the specified settings.
While in the editor, select the necessary code fragment and press Ctrl+Alt+I.
If you need to adjust indentation settings,In the Settings/Preferences dialog (Ctrl+Alt+S), go to .
On the appropriate language page, on the Tabs and Indents tab, specify the appropriate indents options and click OK.
Exclude code from reformatting
You can exclude a group of files or part of code from reformatting.
In the Settings/Preferences dialog (Ctrl+Alt+S), go to .
On the Formatter Control tab, select the Enable formatter markers in comments option.
- On the Formatter Control tab, after you have selected the Enable formatter markers in comments, the scope area becomes active.
Click the icon to add a scope where you can specify files that you want to exclude from reformatting.
If you want to exclude part of code from reformatting, on the Formatter Control tab, select the Enable formatter markers in comments option.
In the editor, at the beginning of a region that you want to exclude, create a line comment (Ctrl+/) and type
//@formatter:off, at the end of the region, again create a line comment and type
Rearrange code entries
You can rearrange your code according to the arrangement rules set on the Arrangement tab located in .
For example, if you need to sort your code entries alphabetically, select the appropriate matching rules entry and set the Order field to order by name.
In the editor, select the code entries you want to rearrange and from the main menu, select.
Configure leading spaces in comments
After you applied the Reformat Code action (Ctrl+Alt+L), GoLand may add leading spaces before the comment text.
In Go, comments are also used as annotations. In some libraries, spaces between comment markers and annotation instructions are not processed correctly. In the previous example,
easyjson:json is an annotation.
You can disable leading spaces for annotations that start with certain prefixes.
Open the Settings window ( ).
Click the Other tab.
Select the Add leading space to comments checkbox.
In the Except for space to comments field, click the Add icon ().
Type the prefix name that you want to add as an exception (for example,