CODEWITHSUNDEEP
processstandardswhitespaceconventions
user271586
user271586

Reputation:

Benefits of stripping trailing white spaces?

I got into the habit of removing trailing white spaces from my source file. In fact, I have my editor to do this automatically. I got in this habit by using git; it created a habit that I adhere to.

My question relates to the fact that I cannot justify this behaviour. I can understand that in some fields, such as web designers, it may impact their final result. For programmer though, what do we gain out of it? Can't we just leave it in?

Upvotes: 8

Views: 1048

Answers (3)

Marco Mariani
Marco Mariani

Reputation: 13766

Mandatory link to a Jeff Atwood post.

Whitespace: The Silent Killer

Upvotes: 1

David Given
David Given

Reputation: 13701

You don't say what language you're using, but in C-alikes, trailing whitespace affects macros.

Consider:

#define FNORD() \
   something complicated here

The \ only works if it's the last character on the line --- so whitespace after it will cause it to break.

Upvotes: 2

sleske
sleske

Reputation: 83599

I also like to trim whitespace. There is no technical requirement to do it, but it has some advantages:

  • Trailing whitespace is irritating in many editors when the cursor changes lines, as you may end up in the "trailing whitespace area" of the line when you go from a longer to a shorter line, requiring extra keystrokes to get to the part you want to edit
  • It may cause your editor to show a horizontal scrollbar that would otherwise not be necessary, which in turn forces you to scroll to the right to make sure you are not missing text

Most of all, however, there is a huge benefit (IMHO) to use consistent formatting throughout the source code (spacing, indentation, brace style...). This makes the code easier to read, and avoids large diffs from reformattings (if it's always corretly formatted, no need to reformat).

Therefore I would recommend letting a formatter run automatically whenever you save (or at least for every commit). That way, trailing whitespace can be eliminated as a side effect :-).

Upvotes: 9

Related Questions