Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
  1. Home
  2. The Lounge
  3. Multiple returns from methods or clean code flow

Multiple returns from methods or clean code flow

Scheduled Pinned Locked Moved The Lounge
questiondiscussioncryptographycollaborationhelp
85 Posts 40 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • F Forogar

    I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

    void SomeFunction(SomeThing s)
    {
    if (s != null)
    {
    if (s.Thing != null)
    {
    // Do Some Process with s.Thing
    .
    .
    .
    }
    }
    }

    becomes:

    void SomeFunction(SomeThing s)
    {
    if (s == null) return
    if (s.Thing == null) return;
    // Do Some Process with s.Thing
    .
    .
    .
    }

    This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

    void SomeFunction(SomeThing s)
    {
    if (s != null && s.Thing != null)
    {
    // Do Some Process with s.Thing
    .
    .
    .
    }
    }

    or possibly:

    void SomeFunction(SomeThing s)
    {
    if (s?.Thing != null)
    {
    // Do Some Process with s.Thing
    .
    .
    .
    }
    }

    Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

    - I would love to change the world, but they won’t give me the source code.

    L Offline
    L Offline
    Lost User
    wrote on last edited by
    #28

    It took me a long time to accept multiple returns. Meanwhile I love the concept "If a decision is clear, draw the consequences". And even though, if you are honest, it's a disguised goto; similar to a lot of MS code examples where a loop/break will be "missused".

    It does not solve my Problem, but it answers my question

    1 Reply Last reply
    0
    • Z ZurdoDev

      CodeWraith wrote:

      something goes wrong and you want to get out of there

      That's when you throw an exception.

      CodeWraith wrote:

      Awkward nested if/else blocks?

      Maybe breaking things into functions would be better.

      Social Media - A platform that makes it easier for the crazies to find each other. Everyone is born right handed. Only the strongest overcome it. Fight for left-handed rights and hand equality.

      C Offline
      C Offline
      CodeWraith
      wrote on last edited by
      #29

      ZurdoDev wrote:

      That's when you throw an exception.

      In what way is that better than an early return if your goal is to have a single return point? And catching it yourself at the end of your function does not justify the overhead of throwing an exception. The dreaded GOTO would then be cheaper and no more or less problematic.

      ZurdoDev wrote:

      Maybe breaking things into functions would be better.

      Unless you can't afford to bog down the processor with too much overhead of packing parameters onto the stack or cleaning it up afterwards. On a strong processor that's no big deal anymore, but often enough I sit there with a C compiler and a small microcontroller clocked < 10 MHz. Usually some output pins need to be pulled up or down according to a certain timing, leaving me only a few machine instructions on the microcontroller within that timeframe. In that case I may have to resort to inline assembly and can't afford any function calls.

      I have lived with several Zen masters - all of them were cats. His last invention was an evil Lasagna. It didn't kill anyone, and it actually tasted pretty good.

      Z 1 Reply Last reply
      0
      • C CodeWraith

        ZurdoDev wrote:

        That's when you throw an exception.

        In what way is that better than an early return if your goal is to have a single return point? And catching it yourself at the end of your function does not justify the overhead of throwing an exception. The dreaded GOTO would then be cheaper and no more or less problematic.

        ZurdoDev wrote:

        Maybe breaking things into functions would be better.

        Unless you can't afford to bog down the processor with too much overhead of packing parameters onto the stack or cleaning it up afterwards. On a strong processor that's no big deal anymore, but often enough I sit there with a C compiler and a small microcontroller clocked < 10 MHz. Usually some output pins need to be pulled up or down according to a certain timing, leaving me only a few machine instructions on the microcontroller within that timeframe. In that case I may have to resort to inline assembly and can't afford any function calls.

        I have lived with several Zen masters - all of them were cats. His last invention was an evil Lasagna. It didn't kill anyone, and it actually tasted pretty good.

        Z Offline
        Z Offline
        ZurdoDev
        wrote on last edited by
        #30

        CodeWraith wrote:

        inline assembly and can't afford any function calls.

        Different rules apply to assembly vs. OOP.

        Social Media - A platform that makes it easier for the crazies to find each other. Everyone is born right handed. Only the strongest overcome it. Fight for left-handed rights and hand equality.

        C 1 Reply Last reply
        0
        • F Forogar

          I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

          void SomeFunction(SomeThing s)
          {
          if (s != null)
          {
          if (s.Thing != null)
          {
          // Do Some Process with s.Thing
          .
          .
          .
          }
          }
          }

          becomes:

          void SomeFunction(SomeThing s)
          {
          if (s == null) return
          if (s.Thing == null) return;
          // Do Some Process with s.Thing
          .
          .
          .
          }

          This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

          void SomeFunction(SomeThing s)
          {
          if (s != null && s.Thing != null)
          {
          // Do Some Process with s.Thing
          .
          .
          .
          }
          }

          or possibly:

          void SomeFunction(SomeThing s)
          {
          if (s?.Thing != null)
          {
          // Do Some Process with s.Thing
          .
          .
          .
          }
          }

          Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

          - I would love to change the world, but they won’t give me the source code.

          R Offline
          R Offline
          Rajesh R Subramanian
          wrote on last edited by
          #31

          Forogar wrote:

          if (s != null && s.Thing != null)

          This. Or better yet

          void SomeFunction(SomeThing s)
          {
          if (null == s || null == s.Thing)
          {
          throw blah;
          }
          // use s here with peace of mind
          }

          1 Reply Last reply
          0
          • Z ZurdoDev

            CodeWraith wrote:

            inline assembly and can't afford any function calls.

            Different rules apply to assembly vs. OOP.

            Social Media - A platform that makes it easier for the crazies to find each other. Everyone is born right handed. Only the strongest overcome it. Fight for left-handed rights and hand equality.

            C Offline
            C Offline
            CodeWraith
            wrote on last edited by
            #32

            ZurdoDev wrote:

            Different rules apply to assembly vs. OOP

            Actually it's C code with some inline assembly, if needed. Good C code quickly borders on object orientation, just think of structs containing function pointers plus some preprocessor magic to call the 'constructors' and 'destructors'. That's essentially the way C evolved to C++. You are right, but the rules don't change by what paradigm you choose. It's more like the processor dictating which paradigm you can afford. I still have my first computer, which I built almost 41 years ago. It has a hex keyboard and I still write machine code programs for it. You would not believe how much neatly calling functions bogs down the old processor or how quickly the code to pass parameters to the functions via the stack can eat up the tiny 4k RAM. Old programs are usually a single chunk of spaghetti code, only maintainable because they can't be very large, but they shurely make more out of these limited resources.

            I have lived with several Zen masters - all of them were cats. His last invention was an evil Lasagna. It didn't kill anyone, and it actually tasted pretty good.

            1 Reply Last reply
            0
            • F Forogar

              I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

              void SomeFunction(SomeThing s)
              {
              if (s != null)
              {
              if (s.Thing != null)
              {
              // Do Some Process with s.Thing
              .
              .
              .
              }
              }
              }

              becomes:

              void SomeFunction(SomeThing s)
              {
              if (s == null) return
              if (s.Thing == null) return;
              // Do Some Process with s.Thing
              .
              .
              .
              }

              This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

              void SomeFunction(SomeThing s)
              {
              if (s != null && s.Thing != null)
              {
              // Do Some Process with s.Thing
              .
              .
              .
              }
              }

              or possibly:

              void SomeFunction(SomeThing s)
              {
              if (s?.Thing != null)
              {
              // Do Some Process with s.Thing
              .
              .
              .
              }
              }

              Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

              - I would love to change the world, but they won’t give me the source code.

              S Offline
              S Offline
              Slacker007
              wrote on last edited by
              #33

              fail fast, fail early. end of story.

              1 Reply Last reply
              0
              • F Forogar

                I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

                void SomeFunction(SomeThing s)
                {
                if (s != null)
                {
                if (s.Thing != null)
                {
                // Do Some Process with s.Thing
                .
                .
                .
                }
                }
                }

                becomes:

                void SomeFunction(SomeThing s)
                {
                if (s == null) return
                if (s.Thing == null) return;
                // Do Some Process with s.Thing
                .
                .
                .
                }

                This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

                void SomeFunction(SomeThing s)
                {
                if (s != null && s.Thing != null)
                {
                // Do Some Process with s.Thing
                .
                .
                .
                }
                }

                or possibly:

                void SomeFunction(SomeThing s)
                {
                if (s?.Thing != null)
                {
                // Do Some Process with s.Thing
                .
                .
                .
                }
                }

                Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

                - I would love to change the world, but they won’t give me the source code.

                M Offline
                M Offline
                Mark_Wallace
                wrote on last edited by
                #34

                Forogar wrote:

                which is bad coding practice

                You have to look into who says it's bad coding practice. Let's be honest: the computer doesn't care. It just some human's personal preference, which he's written down in a book. You don't have to follow anyone's personal preferences -- the computer doesn't care whose preferences you follow.

                Forogar wrote:

                This makes a complete hash of the natural flow of the code

                OK, if you see it that way, that's your preference, and I won't try to change that. But, to me, it looks like that's a way that the computer would be happier doing it, so my preference in this doesn't match yours.

                Forogar wrote:

                If I was to refactor the code

                If I were to refactor your statement, it would look like this:

                Mark Wallace prefers:

                If I were to refactor the code

                Which amounts to the same thing; it's all about personal preferences. Make sure that you follow your own preferences, not those of someone who wrote a book, just because a few of his other ideas are good. ... Unless, of course, you have coding standards, where you work -- in which case, follow those religiously.

                I wanna be a eunuchs developer! Pass me a bread knife!

                1 Reply Last reply
                0
                • Z ZurdoDev

                  I believe I am in the minority on this but I prefer one single return statement. Multiple returns adds unnecessary confusion. For example, if you put a breakpoint near the end of a function and it never hits it may be because of the early returns so you have to go hunting around to find out what's going on. One return.

                  Social Media - A platform that makes it easier for the crazies to find each other. Everyone is born right handed. Only the strongest overcome it. Fight for left-handed rights and hand equality.

                  M Offline
                  M Offline
                  Mark_Wallace
                  wrote on last edited by
                  #35

                  ZurdoDev wrote:

                  One return.

                  There is only one return, from the program-flow perspective: the one it hits first. When a program is running, the number of lines of code that are read varies according to loops and if statements. Having lots of quickly finished loops and quick escapes from if blocks is like hitting green lights all the way down the road. Save your processor a billionth of a second of effort: let it get out as soon as it knows it has to get out.

                  I wanna be a eunuchs developer! Pass me a bread knife!

                  C 1 Reply Last reply
                  0
                  • F Forogar

                    I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

                    void SomeFunction(SomeThing s)
                    {
                    if (s != null)
                    {
                    if (s.Thing != null)
                    {
                    // Do Some Process with s.Thing
                    .
                    .
                    .
                    }
                    }
                    }

                    becomes:

                    void SomeFunction(SomeThing s)
                    {
                    if (s == null) return
                    if (s.Thing == null) return;
                    // Do Some Process with s.Thing
                    .
                    .
                    .
                    }

                    This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

                    void SomeFunction(SomeThing s)
                    {
                    if (s != null && s.Thing != null)
                    {
                    // Do Some Process with s.Thing
                    .
                    .
                    .
                    }
                    }

                    or possibly:

                    void SomeFunction(SomeThing s)
                    {
                    if (s?.Thing != null)
                    {
                    // Do Some Process with s.Thing
                    .
                    .
                    .
                    }
                    }

                    Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

                    - I would love to change the world, but they won’t give me the source code.

                    T Offline
                    T Offline
                    Tim Deveaux
                    wrote on last edited by
                    #36

                    I'm definitely in the single exit camp. And, after browsing this thread, finding it very hard to argue the case for it beyond "'cause I am, that's why!" I just like knowing there's a single exit point where I nuke that pointer if it's non-null etc.

                    "Look here you function - or threadproc - or whatever it is you call your self, you're not getting out of here until your hair is combed and you've buttoned your shirt."

                    If I were to use the multiple return paradigm I think I'd use multiple goto exit's instead. Which seems kinda uglee. I'm definitely in the single exit camp. 'cause I am, that's why.

                    M 1 Reply Last reply
                    0
                    • T Tim Deveaux

                      I'm definitely in the single exit camp. And, after browsing this thread, finding it very hard to argue the case for it beyond "'cause I am, that's why!" I just like knowing there's a single exit point where I nuke that pointer if it's non-null etc.

                      "Look here you function - or threadproc - or whatever it is you call your self, you're not getting out of here until your hair is combed and you've buttoned your shirt."

                      If I were to use the multiple return paradigm I think I'd use multiple goto exit's instead. Which seems kinda uglee. I'm definitely in the single exit camp. 'cause I am, that's why.

                      M Offline
                      M Offline
                      Mark_Wallace
                      wrote on last edited by
                      #37

                      Tim Deveaux wrote:

                      after browsing this thread, finding it very hard to argue the case for it beyond "'cause I am, that's why!"

                      That's a good enough reason. Me, I see adding returns where they fit as being more efficient (which it is), but unless you're doing something really intensive like editing high-res game graphics or video (where loops and if-blocks are hit, quite literally, billion of times), it won't make a difference that's human-noticeable, so stick to what you're happy with, and what makes your code easier on your eye, when you have to revisit it.

                      Tim Deveaux wrote:

                      If I were to use the multiple return paradigm I think I'd use multiple goto exit's instead. Which seems kinda uglee.

                      Every jump to a non-sequential line is a goto. Loops and if statements were invented to save you the trouble of writing endless goto lines, by adding them for you, in the background behind the code. Think: What does return do that goto doesn't? (Answer: it satisfies the anti-goto evangelists, by using a function named "return", which does nothing but call goto.) Saying that the goto is unacceptable is saying that if and for are unacceptable. Never be afraid of using a goto in sequential code, as long as you use it intelligently. E.g. exiting an if-block with a goto is usually fine, but exiting a loop with a goto often isn't (unless you're only using global variables, which... Yeah, no need to expound on that one).

                      I wanna be a eunuchs developer! Pass me a bread knife!

                      T 1 Reply Last reply
                      0
                      • F Forogar

                        I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

                        void SomeFunction(SomeThing s)
                        {
                        if (s != null)
                        {
                        if (s.Thing != null)
                        {
                        // Do Some Process with s.Thing
                        .
                        .
                        .
                        }
                        }
                        }

                        becomes:

                        void SomeFunction(SomeThing s)
                        {
                        if (s == null) return
                        if (s.Thing == null) return;
                        // Do Some Process with s.Thing
                        .
                        .
                        .
                        }

                        This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

                        void SomeFunction(SomeThing s)
                        {
                        if (s != null && s.Thing != null)
                        {
                        // Do Some Process with s.Thing
                        .
                        .
                        .
                        }
                        }

                        or possibly:

                        void SomeFunction(SomeThing s)
                        {
                        if (s?.Thing != null)
                        {
                        // Do Some Process with s.Thing
                        .
                        .
                        .
                        }
                        }

                        Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

                        - I would love to change the world, but they won’t give me the source code.

                        M Offline
                        M Offline
                        Marc Clifton
                        wrote on last edited by
                        #38

                        It's an old lesson I learned, probably from the days of assembly -- always have one point of return, mainly for consistent stack cleanup. I do rarely make an exception (to that rule) but usually end up making some other change that removes the if. If you're doing parameter checking, as in your example, I tend to think it's better to throw an exception -- why should the function that's being called expect anything but valid parameters? I've seen return sprinkled throughout a function as part of the flow control. I hate that. Sometimes I don't see the return, set the breakpoint at the end of the function, and then have to steps through from the top and realize some moron tossed in an early return. I'd almost rather they use a goto to the return, haha. Personally, I look at code like that and refactor it into smaller functions that have no if statements, and the flow control occurs in a higher level function that doesn't do anything but call other functions based on conditions of previous functions or the data values. A lot more readable too when you separate out the flow control from the individual activities of each flow.

                        Latest Article - Slack-Chatting with you rPi Learning to code with python is like learning to swim with those little arm floaties. It gives you undeserved confidence and will eventually drown you. - DangerBunny Artificial intelligence is the only remedy for natural stupidity. - CDP1802

                        B 1 Reply Last reply
                        0
                        • M Mark_Wallace

                          Tim Deveaux wrote:

                          after browsing this thread, finding it very hard to argue the case for it beyond "'cause I am, that's why!"

                          That's a good enough reason. Me, I see adding returns where they fit as being more efficient (which it is), but unless you're doing something really intensive like editing high-res game graphics or video (where loops and if-blocks are hit, quite literally, billion of times), it won't make a difference that's human-noticeable, so stick to what you're happy with, and what makes your code easier on your eye, when you have to revisit it.

                          Tim Deveaux wrote:

                          If I were to use the multiple return paradigm I think I'd use multiple goto exit's instead. Which seems kinda uglee.

                          Every jump to a non-sequential line is a goto. Loops and if statements were invented to save you the trouble of writing endless goto lines, by adding them for you, in the background behind the code. Think: What does return do that goto doesn't? (Answer: it satisfies the anti-goto evangelists, by using a function named "return", which does nothing but call goto.) Saying that the goto is unacceptable is saying that if and for are unacceptable. Never be afraid of using a goto in sequential code, as long as you use it intelligently. E.g. exiting an if-block with a goto is usually fine, but exiting a loop with a goto often isn't (unless you're only using global variables, which... Yeah, no need to expound on that one).

                          I wanna be a eunuchs developer! Pass me a bread knife!

                          T Offline
                          T Offline
                          Tim Deveaux
                          wrote on last edited by
                          #39

                          Mark_Wallace wrote:

                          ... stick to what you're happy with

                          Yes - in that it's a matter of style. If I was working on a codebase that used the fast exit religiously, I'd stick to it - better not to mix styles. But my style it definitely ain't - and that's part of it - the reassurance that if I wrote this my way it exits here - which is worth more to me than the (alleged) increase in readability.

                          1 Reply Last reply
                          0
                          • OriginalGriffO OriginalGriff

                            Whitesmiths.

                            Sent from my Amstrad PC 1640 Never throw anything away, Griff Bad command or file name. Bad, bad command! Sit! Stay! Staaaay... AntiTwitter: @DalekDave is now a follower!

                            J Offline
                            J Offline
                            Jon McKee
                            wrote on last edited by
                            #40

                            You're a monster :laugh: Allman ftw.

                            1 Reply Last reply
                            0
                            • C CodeWraith

                              Still: Yuck!

                              I have lived with several Zen masters - all of them were cats. His last invention was an evil Lasagna. It didn't kill anyone, and it actually tasted pretty good.

                              C Offline
                              C Offline
                              charlieg
                              wrote on last edited by
                              #41

                              agreed. that is just a nasty example of embedded logic.

                              Charlie Gilley <italic>Stuck in a dysfunctional matrix from which I must escape... "Where liberty dwells, there is my country." B. Franklin, 1783 “They who can give up essential liberty to obtain a little temporary safety deserve neither liberty nor safety.” BF, 1759

                              1 Reply Last reply
                              0
                              • F Forogar

                                I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

                                void SomeFunction(SomeThing s)
                                {
                                if (s != null)
                                {
                                if (s.Thing != null)
                                {
                                // Do Some Process with s.Thing
                                .
                                .
                                .
                                }
                                }
                                }

                                becomes:

                                void SomeFunction(SomeThing s)
                                {
                                if (s == null) return
                                if (s.Thing == null) return;
                                // Do Some Process with s.Thing
                                .
                                .
                                .
                                }

                                This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

                                void SomeFunction(SomeThing s)
                                {
                                if (s != null && s.Thing != null)
                                {
                                // Do Some Process with s.Thing
                                .
                                .
                                .
                                }
                                }

                                or possibly:

                                void SomeFunction(SomeThing s)
                                {
                                if (s?.Thing != null)
                                {
                                // Do Some Process with s.Thing
                                .
                                .
                                .
                                }
                                }

                                Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

                                - I would love to change the world, but they won’t give me the source code.

                                C Offline
                                C Offline
                                charlieg
                                wrote on last edited by
                                #42

                                I think there are several issues at play here, the most important is one of consistency. If someone coming behind you can pick up on your style, much of the griping goes by the wayside. I am a strong supporter of early return - range checking arguments and the like. Where you get in to trouble is a 500 line function with nested returns - OR - so many levels of logic (to avoid nested returns) that it's screaming at you to re-factor it....

                                Charlie Gilley <italic>Stuck in a dysfunctional matrix from which I must escape... "Where liberty dwells, there is my country." B. Franklin, 1783 “They who can give up essential liberty to obtain a little temporary safety deserve neither liberty nor safety.” BF, 1759

                                1 Reply Last reply
                                0
                                • F Forogar

                                  I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

                                  void SomeFunction(SomeThing s)
                                  {
                                  if (s != null)
                                  {
                                  if (s.Thing != null)
                                  {
                                  // Do Some Process with s.Thing
                                  .
                                  .
                                  .
                                  }
                                  }
                                  }

                                  becomes:

                                  void SomeFunction(SomeThing s)
                                  {
                                  if (s == null) return
                                  if (s.Thing == null) return;
                                  // Do Some Process with s.Thing
                                  .
                                  .
                                  .
                                  }

                                  This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

                                  void SomeFunction(SomeThing s)
                                  {
                                  if (s != null && s.Thing != null)
                                  {
                                  // Do Some Process with s.Thing
                                  .
                                  .
                                  .
                                  }
                                  }

                                  or possibly:

                                  void SomeFunction(SomeThing s)
                                  {
                                  if (s?.Thing != null)
                                  {
                                  // Do Some Process with s.Thing
                                  .
                                  .
                                  .
                                  }
                                  }

                                  Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

                                  - I would love to change the world, but they won’t give me the source code.

                                  M Offline
                                  M Offline
                                  Member 9167057
                                  wrote on last edited by
                                  #43

                                  Not messy at all. When reading through a method line-by-line

                                  if SomeErrorCondition then
                                  Exit(ErrorCode);

                                  is actually pretty darn readable. When debugging, setting one breakpoint at the single return statement and then fiddling which branch of the nested if-statement was taken isn't really easier than putting a breakpoint at every return statement and see which gets hit.

                                  1 Reply Last reply
                                  0
                                  • F Forogar

                                    I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

                                    void SomeFunction(SomeThing s)
                                    {
                                    if (s != null)
                                    {
                                    if (s.Thing != null)
                                    {
                                    // Do Some Process with s.Thing
                                    .
                                    .
                                    .
                                    }
                                    }
                                    }

                                    becomes:

                                    void SomeFunction(SomeThing s)
                                    {
                                    if (s == null) return
                                    if (s.Thing == null) return;
                                    // Do Some Process with s.Thing
                                    .
                                    .
                                    .
                                    }

                                    This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

                                    void SomeFunction(SomeThing s)
                                    {
                                    if (s != null && s.Thing != null)
                                    {
                                    // Do Some Process with s.Thing
                                    .
                                    .
                                    .
                                    }
                                    }

                                    or possibly:

                                    void SomeFunction(SomeThing s)
                                    {
                                    if (s?.Thing != null)
                                    {
                                    // Do Some Process with s.Thing
                                    .
                                    .
                                    .
                                    }
                                    }

                                    Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

                                    - I would love to change the world, but they won’t give me the source code.

                                    D Offline
                                    D Offline
                                    Delphi 7 Solutions
                                    wrote on last edited by
                                    #44

                                    I think that the Return statement should be dropped in any language, for example look at Delphi (object pascal) they did not have a return statement until recently it seems. A function had to fill up a variable called Result, and because there was no return statement developers where forced to maintain a clean flow. This is how it should be everywhere IMHO

                                    K Richard DeemingR 2 Replies Last reply
                                    0
                                    • C CodeWraith

                                      Nice and well, until you sit in the middle of several levels of conditions, something goes wrong and you want to get out of there. What then? Awkward nested if/else blocks? Or do we just make use of the good old GOTO to hop to your single return at the end? I do exactly that often enough in assembly programs, just because I need a single return as a point where I clean up the stack frame before actually returning. I don't really see the point if it's only a matter of principle.

                                      I have lived with several Zen masters - all of them were cats. His last invention was an evil Lasagna. It didn't kill anyone, and it actually tasted pretty good.

                                      K Offline
                                      K Offline
                                      kalberts
                                      wrote on last edited by
                                      #45

                                      CodeWraith wrote:

                                      Nice and well, until you sit in the middle of several levels of conditions, something goes wrong and you want to get out of there. What then?

                                      For those situations, I loved the exit mechanism in the CHILL language: Any composite statement could be labeled (a function body was a composite statement labeled by the function name). The label did not identify a "point" in the code, but the entire composite. So you could exit any composite statement by "EXIT label". (Another nice use of the label: You could add it to the termination of the composite statement, any sort of END statement, easing the reading of deeply nested code, and the compiler would check the label to make sure that you made no mistakes in the nesting.) Unfortunately, CHILL never got out of telephone switch programming (for which it was developed). It really was a nice language in a lot of respects.

                                      1 Reply Last reply
                                      0
                                      • OriginalGriffO OriginalGriff

                                        Under most circumstances, a single return is best. But ... I much prefer this:

                                        void MyFunc ()
                                        {
                                        if (!ValidateUserInput(ATextBox.Text))
                                        {
                                        TellUserAboutTheProblem();
                                        return;
                                        }
                                        if (!ValidateUserInput(AnotherTextBox.Text))
                                        {
                                        TellUserAboutTheProblem();
                                        return;
                                        }
                                        ...
                                        }

                                        To this:

                                        void MyFunc ()
                                        {
                                        if (!ValidateUserInput(ATextBox.Text))
                                        {
                                        TellUserAboutTheProblem();
                                        }
                                        else if (!ValidateUserInput(AnotherTextBox.Text))
                                        {
                                        TellUserAboutTheProblem();
                                        }
                                        else
                                        {
                                        ...
                                        }
                                        }

                                        And sometimes the best thing to do is just return, particularly from a nested loop:

                                        for (int i = 0; i < 100; i++)
                                        {
                                        for (int j = 0; j < 100; j++)
                                        {
                                        if (myArray[i, j] == value) return true;
                                        }
                                        }
                                        return false;

                                        Any other mechanism is just making it more complicated, not less.

                                        Sent from my Amstrad PC 1640 Never throw anything away, Griff Bad command or file name. Bad, bad command! Sit! Stay! Staaaay... AntiTwitter: @DalekDave is now a follower!

                                        M Offline
                                        M Offline
                                        megaadam
                                        wrote on last edited by
                                        #46

                                        I thought you were joking when you said Whitesmiths!

                                        for()
                                        {
                                        for()

                                        Really hurts my eyes :sigh:

                                        for()
                                        {
                                        for()

                                        I like.

                                        "If we don't change direction, we'll end up where we're going"

                                        OriginalGriffO 1 Reply Last reply
                                        0
                                        • F Forogar

                                          I have just had a heated argument cage fight lively discussion with some of my team members about ReSharper's suggestion of refactoring code to replace nested ifs with a series of multiple early return statements. This caused horribly messy code that ReSharper actually described in it's help as "more readable"! Using a version of their example code (which is a lot simpler than the actual code in question):

                                          void SomeFunction(SomeThing s)
                                          {
                                          if (s != null)
                                          {
                                          if (s.Thing != null)
                                          {
                                          // Do Some Process with s.Thing
                                          .
                                          .
                                          .
                                          }
                                          }
                                          }

                                          becomes:

                                          void SomeFunction(SomeThing s)
                                          {
                                          if (s == null) return
                                          if (s.Thing == null) return;
                                          // Do Some Process with s.Thing
                                          .
                                          .
                                          .
                                          }

                                          This makes a complete hash of the natural flow of the code and introduces an execution statement (return) on the same line as the "if" which is bad coding practice, and then does it again, and then drops though to do some actual processing. If I was to refactor the code it would do this:

                                          void SomeFunction(SomeThing s)
                                          {
                                          if (s != null && s.Thing != null)
                                          {
                                          // Do Some Process with s.Thing
                                          .
                                          .
                                          .
                                          }
                                          }

                                          or possibly:

                                          void SomeFunction(SomeThing s)
                                          {
                                          if (s?.Thing != null)
                                          {
                                          // Do Some Process with s.Thing
                                          .
                                          .
                                          .
                                          }
                                          }

                                          Which is a lot cleaner! ...and this isn't even considering a method that returns a value of some sort. Opinions?

                                          - I would love to change the world, but they won’t give me the source code.

                                          D Offline
                                          D Offline
                                          Davyd McColl
                                          wrote on last edited by
                                          #47

                                          I'm not sure which version of ReSharper you're using, but modern versions of Rider (which use ReSharper via IPC) would have recommended an early return with the ?. syntax you're proposing, granting you both the shorter expression and shallower nesting, which is good for readability. Early returns do make the code easier to grok, if for no other reason than that it looks less like a giant chevron heading off into the distant future.

                                          1 Reply Last reply
                                          0
                                          Reply
                                          • Reply as topic
                                          Log in to reply
                                          • Oldest to Newest
                                          • Newest to Oldest
                                          • Most Votes


                                          • Login

                                          • Don't have an account? Register

                                          • Login or register to search.
                                          • First post
                                            Last post
                                          0
                                          • Categories
                                          • Recent
                                          • Tags
                                          • Popular
                                          • World
                                          • Users
                                          • Groups