Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Comments on Is omitting braces for single statements bad practice?

Parent

Is omitting braces for single statements bad practice?

+9
−4

Consider this code:

while(arr[index] != 0)
    index++;

vs

while(arr[index] != 0) {
    index++;
}

Personally, I prefer the first. The fact that the braces are not needed makes them -- unnecessary. :)

To me, it's just clutter that wastes a line. Or 2 if you're one of them that also want the opening brace on a new line. The line waste can be avoided though, if you do like this:

while(arr[index] != 0) index++;

I often do that, and I like the style. Partially because it makes those loops stand out from loops with braces.

One argument I've heard for always using braces is that if you want to add another statement, then you need to remember adding braces or you will have bugs that can be hard to find. For instance, this would be an endless loop:

while(arr[index] != 0) 
    println("No zero found");
    index++;

While this is technically true that this mistake can be done, I find it a bit meh as an argument. If you're using an editor that autoindents the code, this mistake would be spotted immediately. And since using such an editor is something that you should do anyway, the point of this argument is a bit moot.

Plus, even though I have often coded without such an editor, I cannot remember ever doing that mistake. It feels like a mistake that one could do if you're used to Python. But adjusting coding standards of C, C++, Java and such to not confuse Python coders does not really seem like the right path to go.

Apart from this argument, I have not really seen anything else than the consistency argument. That always using the same style is consistent. Well it's true, but consistency is not ALWAYS good.

Have I missed something here? What do you say? Is omitting braces for single statements bad practice?

History
Why does this post require moderator attention?
You might want to add some details to your flag.
Why should this post be closed?

2 comment threads

Put the `{` on the next line and you wouldn't waste any lines. (1 comment)
General comments (5 comments)
Post
+4
−0

I'm in the "Use the braces. Just use them every time" camp [1]. As others have suggested you or your tooling will catch a lot of cases where you screw up on this, but the ones that slip through can really hurt.

So, I was surprised to hear Robert "Uncle Bob" Martin opine that he's "on a mission to destroy all braces" (video link, but to the quote).

Now it was clear from the context that his preference is to get all the while statements into a form like

while ( someClearlyNamedCondition() )
    takeClearlyNamedAction();

and similarly for if, so that there is never a need to have more than one line following the condition (changes to the named action should be made in takeClearlyNamedAction(), right?) and the code can be read aloud without ambiguity or difficulty.

Making that work is going to take some serious dedication to clean code and refactoring as you go, but elsewhere in the video series, Uncle Bob talks about the importance that he sees in adopting a discipline in your coding (he has TDD in particular in mind and gives an enlightening demonstration of how he goes about that).


  1. This is a change for me and one that has been slow in coming. I'm old enough to have done most of my formative programming in terminals with a severely limited number of lines (hey but at least they were CRTs: many of the people I learned from had learned on punch cards and line printers). For a long time I was a proponent of formatting decisions that saved vertical space (K&R braces, leaving off unnecessary brackets, and so on). Even then I would sometimes print code so that I could examine it in the large. ↩︎

History
Why does this post require moderator attention?
You might want to add some details to your flag.

1 comment thread

General comments (2 comments)
General comments
Canina‭ wrote over 3 years ago

The problem with the someClearlyNamedCondition()/takeClearlyNamedAction() approach is when, to take that action, you need access to a variety of variables that are in scope for the while statement, but won't be in scope in a different function. It gets even worse if takeClearlyNamedAction() needs to mutate more than one piece of state. Now you're potentially introducing additional functions (which means mental context switching) just to avoid { }. Seems to me like a bad trade-off.

dmckee‭ wrote over 3 years ago

@Canina These are exactly the reasons I don't push hard to get to that simple structure. That said, I imagine that if we hunted down a "clean code" evangelist and offered them a coffee to discuss this they'd tell us we need to use more and more carefully chosen abstractions so the state that looks so diverse in my code would belong to a small number of objects reducing the parameter lists to something reasonable. I experimenting with this on a small scale and so far the results seem worthwhile.