How to config intellij-idea not format some part of the code?

Question

In a html file, there is some code used custom template-language:

<script type="text/javascript">
    function ($scope, JsRoutes) {
        $scope.rows = [
            ${"#{list rows, as: 'row', separator: ','}"}
            {
            #{list fieldConfigs, as: 'f', separator: ','}
            ${f.name} : ${'$'}{row.${f.name}.toJson()}#{/list}
            }
            ${'#{/list}'}
        ]
    }
</script>

Is it possible to configure intellij-idea not to format it(but format the other part of the document)? Since idea will make it hard to read after formatting:

<script type="text/javascript">
    function ($scope, JsRoutes) {
        $scope.rows = [
            ${"#{list rows, as: 'row', separator: ','}"}
            {
    #{list fieldConfigs, as: 'f', separator: ','}
    ${f.name} :
        ${'$'}{
            row.${f.name}.toJson()
        }#{/list}
    }
    ${'#{/list}'}
    ]
    }
</script>

possible duplicate of [How to disable code formatter for some part of the code?](http://stackoverflow.com/questions/3375307/how-to-disable-code-formatter-for-some-part-of-the-code) — Jacek Laskowski, Jan 15 '15 at 06:30

score 50 · Answer 1 · edited Mar 09 '16 at 08:15

50

In my version EAP 13.1, you must enable the following option in settings,

Preferences -> Code Style -> General -> Formatter Control -> Enable formatter markers in comments

before you can use these comments,

// @formatter:off

// @formatter:on

or these (depending on language):

<!--@formatter:off-->

<!--@formatter:on-->

Screenshot:

Screenshot highlighting the checkbox for Enable formatter markers in comments under Preferences

edited Mar 09 '16 at 08:15

Saran

3,845
3
37
59

answered May 06 '14 at 04:09

fawkes

620
1
5
5

1

This did the trick for me, thank you! I think this should be the accepted answer as it was meanwhile added as a feature to IntelliJ IDE. – Julian Sievers May 26 '14 at 09:46

score 46 · Accepted Answer · edited Aug 20 '19 at 13:58

46

This feature has been implemented and you can now disable formatting for the regions of code using the special comments.

After enabling this feature in the settings, add //@formatter:off at the start of your region, and //@formatter:on at the end of it.

These are the default markers, and they are configurable.

You can find more details and examples in the documentation:

Original answer from 2012:

~~It's not possible yet, please vote for this feature request:~~

IDEA-56995 Disable code formatting per region using comments

edited Aug 20 '19 at 13:58

orirab

2,915
1
24
48

answered Dec 24 '12 at 10:59

CrazyCoder

389,263
172
990
904

2

I don't want to use comments on my code just for intellij not to destroy my indentation I have worked so hard to get aligned, for instance defining properties. This setting should be available on full project, without a comment. But I want to be able to reformat when I say format, or indent. Now I am left with possibly turning off the functionality completely by walking through the Java code style and checking boxes. – mjs Jul 12 '14 at 09:16
This has been fixed - see below for how to enable it. – homaxto Feb 23 '17 at 14:02

Martin Seeler · Answer 3 · 2014-01-24T08:39:18.477

9

Since EAP 13 you can trigger the formatter with the following comments:

// @formatter:off
...
// @formatter:on

To enable it in "surround with", you can define a Live Template in the section "surround" with:

// @formatter:off
$SELECTION$
// @formatter:off

You can find these settings in Settings -> Code Style -> General and set your own trigger words.

edited Jan 24 '14 at 08:39

answered Jan 24 '14 at 08:33

Martin Seeler

6,874
3
33
45

score 2 · Answer 4 · answered Mar 09 '17 at 13:00

2

It's worth noting that the formatter control does not appear to work in javadoc comments. It needs to be either in a regular C or C++-style comment. So // @formatter:off works /* @formatter:off */ also works, but /** @formatter:off */ does not.

answered Mar 09 '17 at 13:00

Andy Piper

563
4
10

How to config intellij-idea not format some part of the code?

4 Answers4

Linked