Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to reformat multi-line comments in Eclipse PDT?

In Eclipse PDT, Ctrl-Shift-F reformats code. However, it doesn't modify comments at all. Is there some way to reformat ragged multi-line comments to 80 characters per line (or whatever)?

i.e. convert

// We took a breezy excursion and 
// gathered Jonquils from the river slopes.  Sweet Marjoram grew 
// in luxuriant 
// profusion by the window that overlooked the Aztec city.

to

// We took a breezy excursion and gathered Jonquils 
// from the river slopes.  Sweet Marjoram grew in 
// luxuriant profusion by the window that overlooked 
// the Aztec city.

(I think this applies to regular Eclipse as well.)

Update Turns out that Eclipse in Java mode will reformat the lines above, but only if they're /* */-style comments. It will shorten // lines that are too long, but it won't join lines that are too short together.

like image 743
mjs Avatar asked Sep 25 '08 10:09

mjs


3 Answers

You probably need to configure the Java formatter to include comments.

Preferences -> Java -> Code Style -> Formatter -> Edit... -> Comments

Make sure that "Enable XXX comment formatting" is enabled.

like image 118
JesperE Avatar answered Sep 20 '22 11:09

JesperE


I've never really been able to get the Eclipse formatter to format my code exactly how I want, and this is just one of several shortcomings I've encountered. I've heard the Jalopy formatter is much better. There's both a commercial and free version available with Eclipse plugins for both. I've heard the commercial version is more sophisticated (development on the free version appears to have stalled), but I haven't actually used either personally.

like image 24
Dónal Avatar answered Sep 22 '22 11:09

Dónal


My solution involves using the vrapper plugin (free): http://vrapper.sourceforge.net/home/ which gives you vim support within your text editor.

Once the vrapper plugin is installed you can press v to go into visual mode, highlight your multi-line comment and then press G+Q to auto format the comment so that lines are 80 columns in width (default). You can change the default column width, but you'll need to read the documentation for the vrapper plugin. Cheers!

like image 26
Dustin Biser Avatar answered Sep 22 '22 11:09

Dustin Biser