Eclipse: Can you format code on save?

Question

In Eclipse, under Windows -> Preference -> Java -> Code Style, you can define code templates for comments and code, and you can setup a code formatter.

I'm wondering if it is possible in Eclipse to have these setting take affect every time I save a source file. Basically, instead of me highlighting everything and pressing Ctrl+Shift+F, I want Eclipse to be responsible for making sure my code is formatted properly.

Is this possible and how do you set it up?

Note On Using the Auto-Format: It's probably best to choose "Format Edited Lines" as merging changes becomes very difficult when you reformat a whole file that is in source control already that was not formatted properly. Already did this to a co-worker.

Great question, but I disagree with enabling "Format Edited Lines". If the whole team has access to the same format XML descriptor via SCM then the team should expect their files to be reformatted. In other words, the short term pain of merging is worth the benefit of consistent formatting. — Dave, Dec 07 '11 at 15:37
@HDave agree. The code should at any time be robust against a "Format Source" on all projects. — Thorbjørn Ravn Andersen, May 29 '12 at 14:36
@ThorbjørnRavnAndersen If everyone is using these settings, you can select "Format Edited Lines". It will save some time if your files are large. I agree with you about necessity of the code being robust against a "Format Source", but it's not the task of eclipse to make sure that this is the case, I think. — brimborium, Jul 20 '12 at 09:49
@brimborium a political decision. Personally I believe that the closer you stay to default settings the smoother things will run. — Thorbjørn Ravn Andersen, Jul 20 '12 at 09:58
@ThorbjørnRavnAndersen That would mean the auto-format option being turned off... ;) I mean, I always save by `Ctrl+Shift+F` followed by `Ctrl+S`, so it would be fine by me, but there are other guys who don't care about formating. This feature makes our life so much easier... — brimborium, Jul 20 '12 at 10:21
Gah. Eclipse formats trivial behaviour-less getter/setter properties out to multiple-line functions. Since studies have shown code comprehension & productivity are closely linked to vertical-space usage, I recommend keeping trivial properties compact; 3-4 lines including comment & both getter/setter. Auto-format is for low-performing teams, not highly competent ones. — Thomas W, Mar 02 '13 at 02:16

score 216 · Accepted Answer · edited Apr 11 '17 at 14:32

216

Under Preferences, choose Java --> Editor --> Save Actions. Check the Perform the selected actions on save, and check the Format source code box.

This may or may not be available in previous versions of Eclipse. I know it works in:

Version: 3.3.3.r33x_r20080129-_19UEl7Ezk_gXF1kouft<br>
Build id: M20080221-1800

edited Apr 11 '17 at 14:32

M. A. Kishawy

5,001
11
47
72

answered Oct 24 '08 at 17:53

Neal Swearer

2,482
1
16
11

3

This looks very useful -- is there a way to achieve the same for PHP code? – Vacilando Mar 06 '12 at 13:13
3

Fine, but how do you do the same for non-Java files? – P Varga Jun 26 '12 at 08:12
@PéterVarga if you're using PyDev, [check this](http://stackoverflow.com/questions/1043433/how-to-auto-remove-trailing-whitespace-in-eclipse#answer-3176057) – william_grisaitis Jun 29 '12 at 18:42
1

This looks very useful -- is there a way to achieve the same for C++ code? – HAL9000 Dec 24 '12 at 09:27
1

"Preferences" is in the "Window" menu, that first step is missing from this answer. – Andrew Koster Nov 09 '22 at 17:35

score 16 · Answer 2 · edited Apr 11 '17 at 14:39

16

I have a snapshot of the setting. Please follow the path:

In the Preferences window, choose Java --> Editor --> Save Actions.

Check the Perform the selected actions on save, and check the Format source code box.

enter image description here

edited Apr 11 '17 at 14:39

M. A. Kishawy

5,001
11
47
72

answered Jun 26 '15 at 06:14

VedantK

9,728
7
66
71

"Preferences" is in the "Window" menu, that first step is missing from this answer. – Andrew Koster Nov 09 '22 at 17:35

score 14 · Answer 3 · answered Mar 26 '09 at 10:49

14

I strongly recommend checking your eclipse format xml descriptor into source control. That way all members of the team can use it and you don't get to and fro reformatting battles.

answered Mar 26 '09 at 10:49

serg10

31,923
16
73
94

Can this be done so that the XML file is installed by default? – Dave Dec 07 '11 at 15:32
Interesting idea, but it's incomplete and also doesn't answer the question. – Andrew Koster Nov 09 '22 at 17:36

score 1 · Answer 4 · edited Apr 11 '17 at 14:34

1

If you find that you do not have a Save Actions preference under Java--> Editor, it may be because you are using an older version of Eclipse. In that case you can install the Format on save plugin from here.

Then, under Preferences, choose Java --> Format on save. Select the Run Format option under Select a code formatting action

edited Apr 11 '17 at 14:34

M. A. Kishawy

5,001
11
47
72

answered Aug 10 '09 at 17:14

"Preferences" is in the "Window" menu, that first step is missing from this answer. – Andrew Koster Nov 09 '22 at 17:35

Eclipse: Can you format code on save?

4 Answers4

Linked

Related