Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Re^4: How has your coding style changed over the years?

by Tux (Canon)
on Aug 10, 2022 at 11:03 UTC ( #11146075=note: print w/replies, xml ) Need Help??


in reply to Re^3: How has your coding style changed over the years?
in thread How has your coding style changed over the years?

I also believe in indented closing braces (and I don't care Larry disagrees). I feel strongly for indenting them, as that is IMHO the only logical way to do it.

sub foo { my @args = @_; unless (scalar @args) { warn "No args in foo!"; return; } return join ':' => @args; }

This style is called Ratliff- or Banner-style.

Because braces are just syntactic sugar to keep a block together, it should visually also bind to the block, and not to the conditional. As the closing brace - or END in languages like PASCAL - is visually showing me the end of the block, it should obviously have the same indent as the block itself. An advantage is that the alignment of the closing brace with the block emphasizes the fact that the entire block is conceptually (as well as programmatically) a single compound statement.

In other words: I see the braces being part of the block, and as all statements inside a block share the same indentation, in my opinion the brace - being part of the block - should have the same indentation too.

  • Indent width is 4, tabs are allowed (when set to 8). I prefer having it being spaces only, but as I cannot see the difference with good editors, I do not really care.
  • Opening brace should be on the same line as the conditional
  • Block should be indented
  • Closing brace should have the same indent as the block

Enjoy, Have FUN! H.Merijn

Replies are listed 'Best First'.
Re^5: How has your coding style changed over the years?
by Your Mother (Archbishop) on Aug 10, 2022 at 16:56 UTC

    That’s really interesting and I don’t think I’ve encountered it. Initially I wanted to dislike it because I see balanced characters as needing whitespace balance. So that style would be roughly equivalent to something like for (@array ) { …, which rankles. But the vertical space with the closing brace makes it “work” and the block indentation argument is logical. Hmmm… you might have made a convert.

Re^5: How has your coding style changed over the years?
by LanX (Sage) on Aug 10, 2022 at 23:24 UTC
    > or END in languages like PASCAL - is visually showing me the end of the block, it should obviously have the same indent as the block itself.

    > In other words: I see the braces being part of the block,

    I don't understand this argument. From all languages I remember using an end keyword, I can't remember any seeing it as part of the block, but indenting it as part of the surrounding construct.

    e.g. Ruby

    block_name do #statement-1 #statement-2 . . end

    Cheers Rolf
    (addicted to the Perl Programming Language :)
    Wikisyntax for the Monastery

      In my perception/style, that end (and done) should be indented

      sh: for i in 1 2 42 ; do echo $i done csh/tcsh: foreach i (1 2 42) echo $i end

      It is all about the visual understanding of the code-flow. You read the statements start (if/while/do/for/unless/…) en see the *block* will not be executed, and you need to navigate to the next statement (which of course has the same indent), The end is not the next statement, but the (visually uninteresting) end/close of the block belonging to the statement you just skipped. My brain doesn't want to see that end at all when browing code.

      In your Ruby example do and end are syntax only. The represent no action whatsoever and act as { and }. All of them are no statements: they are syntax (to mark start and end of a block), just like ; is to mark the end of a statement.


      Enjoy, Have FUN! H.Merijn
        I understand your motivation and I can see the advantages if the eye can easily "fall thru" to the next statement on same syntax level.

        But I doubt that the "end" was always meant to be part of the block.

        My guess is it evolved from a jump label in assembler, as such a reentry point into the higher level.

        Cheers Rolf
        (addicted to the Perl Programming Language :)
        Wikisyntax for the Monastery

        (Caveat this is of course a subjective almost aesthetic argument and maybe no one's really wrong (except this is just horrible . . . 0.25*:) )

        It feels as if you've (almost) reimplemented python's terrible indentation-is-block structure but kept the requirement that you have to have a non-whitespace terminator token present. With this scheme it seems the worst of both worlds in that you both have to watch indentation levels like a hawk (maybe not a hawk because it's not whitespace semantically significant; perhaps like a slightly drunk kestrel or some other minorly impaired raptor . . .) but also still need to parse out and read for the terminator that also has to be there.

        If there's going to be an explicit terminator then it should be visually interesting (i.e. exdented) so it can be picked out of the flow of the meat of the block. With this scheme I'd feel one can't skim over the contents of the block as easily because the end terminator of said block doesn't stand out so one is then stuck actually parsing the entire block text to find it / make sure the block is syntactically valid.

        But again, personal aesthetics tomayto tomahto let's call the whole thing off.

        And a very tangentially related aside: for command line usage I like the short_loops option for zsh which lets you elide the do/done and use a braced list instead:

        for i in a b c d ; { print $i ; $i/bin/do_foo }

        The cake is a lie.
        The cake is a lie.
        The cake is a lie.

Re^5: How has your coding style changed over the years?
by GrandFather (Saint) on Aug 12, 2022 at 03:57 UTC

    I'm curious to know why the opening brace goes on the conditional line.

    It is reassuring that someone else uses the same argument for indented braces that I do. It seems to be a highly unusual thing!

    Optimising for fewest key strokes only makes sense transmitting to Pluto or beyond

      The opening brace goes on the line of the statement because

      • It saves vertical space: now I can see more code on my screen/window and have a bigger (over)view on the context
      • As the closing vrace, it is just syntax and by that reason does not deserve a line of its own
      • The closing brace has a line of its own, because the last line in the block is likely to change or new lines to be inserted before the brace.

      (In an ideal world, my editor should optionally replace the line with the closing brace with a (coloured) hairline starting at the left indent of the block till the right edge of the windown.)

      Maybe obvious from above: I am not a big fan of too much vertical whitespace. I'd forbid more than one blank line between logical blocks.


      Enjoy, Have FUN! H.Merijn
Re^5: How has your coding style changed over the years?
by Anonymous Monk on Aug 11, 2022 at 11:51 UTC
    sub foo { my @args = @_; unless (scalar @args) { warn "No args in foo!"; return; } return join ':' => @args; }

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://11146075]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others contemplating the Monastery: (4)
As of 2022-12-07 19:31 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?