PhpStorm 2018.3 Help

Code Style

File | Settings | Editor | Code Style for Windows and Linux
PhpStorm | Preferences | Editor | Code Style for macOS
Ctrl+Alt+S icons general settings svg


Scheme

In this area, choose the code style scheme and change it as required. Code style scheme settings are automatically applied every time PhpStorm generates, refactors, or reformats your code.

Code styles are defined at the project level and at the IDE level (global).

  • At the Project level, settings are grouped under the Project scheme, which is predefined and is marked in bold. The Project style scheme is applied to the current project only.

    You can copy the Project scheme to the IDE level, using the Copy to IDE... command.

  • At the IDE level, settings are grouped under the predefined Default scheme (marked in bold), and any other scheme created by the user by the Duplicate command (marked as plain text). Global settings are used when the user doesn't want to keep code style settings with the project and share them.

    You can copy the IDE scheme to the current project, using the Copy to Project... command.

Item

Description

Scheme

From this drop-down list, select the scheme to be used. The predefined schemes are shown bold. The custom schemes, ones created as copies of the predefined schemes, are in plain text. The location where the scheme is stored is written next to each scheme, for example, the Default scheme is stored in the IDE, the Project scheme is stored in the project.

cogwheel black with arrowClick this button to invoke the drop-down list of commands to manage the schemes:

Item

Description

Available for

Copy to IDE...

Choose this command to copy the scheme settings to the IDE.

Project

Export...

Choose this command to export the selected scheme to an xml file in the selected location:

export scheme

Project and IDE

Import Scheme...

Choose this command to import the scheme of the selected type from the specified location:

import scheme

Project and IDE

Copy to Project...

Choose this command to copy the scheme settings to be stored with a project.

IDE

Duplicate...

Choose this command to create a copy of the selected scheme.

IDE

Reset

Choose this command to reset the default or bundled color scheme to the initial defaults shipped with PhpStorm. This command becomes available only if some changes have been done.

IDE

Rename

Choose this command to change the name of the selected custom scheme. Press Enter to save changes, or Escape to cancel.

Custom schemes

Line Separators

PhpStorm lets you configure line separator and indentation options for various languages. When reformatting source code, PhpStorm will apply the specified indentation behavior and skip the sections denoted with the special formatting off/on markers.

Item

Description

Line Separator (for new files)

Use this drop-down list to specify which line separator is to be used in files created by PhpStorm. The available options are:
  • System dependent - choose this option to use the default selection.

  • Unix and macOS (\n) - choose this option to use the Unix and macOS line separator.

  • Windows (\r\n) - choose this option to use the Windows line separator.

  • Classic Mac (\r) - choose this option to use the Classic Mac line separator.

Hard wrap at

In this text box, specify the number of columns to be used to display pages in the editor.

Wrap on typing

Select this checkbox to ensure that edited text always fits in the specified right margin.

Visual guides

In this field, 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.

Indents Detection

Use this area to specify the default options for indentation.

Item

Description

Detect and use existing file indents for editing

Select this checkbox for PhpStorm to detect the existing indents in a file and use them for editing instead of the indents specified in the Code Style settings for the specific language. PhpStorm displays the indentation information in the status bar of the editor. You can click the indentation information to see the available actions such as enable or disable this option, and change the current indentation to the ones specified in the Code Style settings for the specific language.

Status bar indents options

EditorConfig

In this area enable the support of the EditorConfig plugin.

Item

Description

Enable EditorConfig support

Select this checkbox to enable the EditorConfig plugin support. In this case you can specify your own code style settings that override the IDE settings. However, if you decide to use IDE settings after creating the EditorConfig settings file then you need clear the Enable EditConfig support checkbox.

Export

Click this button if you want to export the current IDE code style settings into the .editconfig file.

Formatter Control

In this area, specify the markers to limit code fragments that you want to exclude from reformatting. In the source code, formatting markers are written inside line comments.

Item

Description

Enable formatter markers in comments

  • If this checkbox is selected, fragments of code between line comments with the formatting markers will not be reformatted and will preserve the original formatting. After you select this checkbox, the fields below become available and you can specify the character strings to be treated as formatting markers.

  • If the checkbox is cleared, the formatting markers will be ignored and the code between the line comments with markers will be reformatted.

Markers

Formatter off:

In this text box, specify the character string that will indicate the beginning of a code fragment which you want to exclude from reformatting. Type a character string with the @ symbol in preposition or leave the predefined value @formatter:off.

Formatter on:

In this text box, specify the character string that will indicate the end of a code fragment which you want to exclude from reformatting. Type a character string with the @ symbol in preposition or leave the predefined value @formatter:on.

Regular expressions

Select this checkbox to use regular expressions instead of specifying the formatting markers explicitly. PhpStorm matches formatter on/off markers using the regular expression specified instead of the exact string.

Formatting markers usage example

The original source code

The code after reformatting

ps formatting markers original

When the formatting markers are disabled, the original formatting is broken:
ps formatting markers off

When the formatting markers are enabled, the original formatting is preserved:

ps formatting markers original
Last modified: 18 December 2018

See Also