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. Do you Program in Paragraphs or Sentences?

Do you Program in Paragraphs or Sentences?

Scheduled Pinned Locked Moved The Lounge
comdebuggingquestionlearning
55 Posts 26 Posters 9 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.
  • R RandyBuchholz

    This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

    // Not me
    string Foo(int x)
    {
    if(x == 1)
    {
    return "one";
    }
    else
    {
    return "not one";
    }
    }
    }

    // sometimes me
    string Foo(int x){
    if (x == 1) {
    return "one";
    } else {
    return "not one";
    }
    }

    // usually me
    string Foo(int x) => (x == 1) ? "one" : "not one";

    // often me
    string Foo(this int x) => (x == 1) ? "one" : "not one";

    I do things like this. (Not really this weird though :)).

    public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
    public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
    public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

    So I can write in sentences

    var list = new List {"a", "Hello", "c"};

    list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

    Instead of paragraphs. (something like (methods would be a little different))

    var list = new List {"a", "Hello", "c"};
    if(list.count > 0){
    foreach(var i in list){
    var (condition, temp) = Prepare(i);
    if(condition != null){
    Manipulate(temp);
    }
    }
    }

    Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

    M Offline
    M Offline
    Munchies_Matt
    wrote on last edited by
    #22

    Your coding style sucks.

    1 Reply Last reply
    0
    • R RandyBuchholz

      This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

      // Not me
      string Foo(int x)
      {
      if(x == 1)
      {
      return "one";
      }
      else
      {
      return "not one";
      }
      }
      }

      // sometimes me
      string Foo(int x){
      if (x == 1) {
      return "one";
      } else {
      return "not one";
      }
      }

      // usually me
      string Foo(int x) => (x == 1) ? "one" : "not one";

      // often me
      string Foo(this int x) => (x == 1) ? "one" : "not one";

      I do things like this. (Not really this weird though :)).

      public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
      public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
      public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

      So I can write in sentences

      var list = new List {"a", "Hello", "c"};

      list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

      Instead of paragraphs. (something like (methods would be a little different))

      var list = new List {"a", "Hello", "c"};
      if(list.count > 0){
      foreach(var i in list){
      var (condition, temp) = Prepare(i);
      if(condition != null){
      Manipulate(temp);
      }
      }
      }

      Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

      G Offline
      G Offline
      GenJerDan
      wrote on last edited by
      #23

      Paragraphs, then collapse all the functions I'm not actively messing around with.

      We won't sit down. We won't shut up. We won't go quietly away. YouTube, VidMe and My Mu[sic], Films and Windows Programs, etc. and FB

      K 1 Reply Last reply
      0
      • R RandyBuchholz

        This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

        // Not me
        string Foo(int x)
        {
        if(x == 1)
        {
        return "one";
        }
        else
        {
        return "not one";
        }
        }
        }

        // sometimes me
        string Foo(int x){
        if (x == 1) {
        return "one";
        } else {
        return "not one";
        }
        }

        // usually me
        string Foo(int x) => (x == 1) ? "one" : "not one";

        // often me
        string Foo(this int x) => (x == 1) ? "one" : "not one";

        I do things like this. (Not really this weird though :)).

        public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
        public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
        public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

        So I can write in sentences

        var list = new List {"a", "Hello", "c"};

        list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

        Instead of paragraphs. (something like (methods would be a little different))

        var list = new List {"a", "Hello", "c"};
        if(list.count > 0){
        foreach(var i in list){
        var (condition, temp) = Prepare(i);
        if(condition != null){
        Manipulate(temp);
        }
        }
        }

        Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

        S Offline
        S Offline
        soulesurfer
        wrote on last edited by
        #24

        In your example:

        list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

        The WhenNotEmpty()?. isn't really needed, is it?

        R 1 Reply Last reply
        0
        • R RandyBuchholz

          This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

          // Not me
          string Foo(int x)
          {
          if(x == 1)
          {
          return "one";
          }
          else
          {
          return "not one";
          }
          }
          }

          // sometimes me
          string Foo(int x){
          if (x == 1) {
          return "one";
          } else {
          return "not one";
          }
          }

          // usually me
          string Foo(int x) => (x == 1) ? "one" : "not one";

          // often me
          string Foo(this int x) => (x == 1) ? "one" : "not one";

          I do things like this. (Not really this weird though :)).

          public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
          public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
          public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

          So I can write in sentences

          var list = new List {"a", "Hello", "c"};

          list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

          Instead of paragraphs. (something like (methods would be a little different))

          var list = new List {"a", "Hello", "c"};
          if(list.count > 0){
          foreach(var i in list){
          var (condition, temp) = Prepare(i);
          if(condition != null){
          Manipulate(temp);
          }
          }
          }

          Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

          M Offline
          M Offline
          maze3
          wrote on last edited by
          #25

          Ah good, learnt something new first thing in the morning, now the rest for the day. the this class extensions parameter looks interesting. Might see if can use a bit of it. thanks

          1 Reply Last reply
          0
          • R RandyBuchholz

            This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

            // Not me
            string Foo(int x)
            {
            if(x == 1)
            {
            return "one";
            }
            else
            {
            return "not one";
            }
            }
            }

            // sometimes me
            string Foo(int x){
            if (x == 1) {
            return "one";
            } else {
            return "not one";
            }
            }

            // usually me
            string Foo(int x) => (x == 1) ? "one" : "not one";

            // often me
            string Foo(this int x) => (x == 1) ? "one" : "not one";

            I do things like this. (Not really this weird though :)).

            public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
            public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
            public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

            So I can write in sentences

            var list = new List {"a", "Hello", "c"};

            list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

            Instead of paragraphs. (something like (methods would be a little different))

            var list = new List {"a", "Hello", "c"};
            if(list.count > 0){
            foreach(var i in list){
            var (condition, temp) = Prepare(i);
            if(condition != null){
            Manipulate(temp);
            }
            }
            }

            Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

            J Offline
            J Offline
            Jacquers
            wrote on last edited by
            #26

            I prefer funnels ;P [Modern Art: The Funnel - The Daily WTF](https://thedailywtf.com/articles/modern-art-the-funnel)

            K 1 Reply Last reply
            0
            • R RandyBuchholz

              This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

              // Not me
              string Foo(int x)
              {
              if(x == 1)
              {
              return "one";
              }
              else
              {
              return "not one";
              }
              }
              }

              // sometimes me
              string Foo(int x){
              if (x == 1) {
              return "one";
              } else {
              return "not one";
              }
              }

              // usually me
              string Foo(int x) => (x == 1) ? "one" : "not one";

              // often me
              string Foo(this int x) => (x == 1) ? "one" : "not one";

              I do things like this. (Not really this weird though :)).

              public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
              public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
              public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

              So I can write in sentences

              var list = new List {"a", "Hello", "c"};

              list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

              Instead of paragraphs. (something like (methods would be a little different))

              var list = new List {"a", "Hello", "c"};
              if(list.count > 0){
              foreach(var i in list){
              var (condition, temp) = Prepare(i);
              if(condition != null){
              Manipulate(temp);
              }
              }
              }

              Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

              Sander RosselS Offline
              Sander RosselS Offline
              Sander Rossel
              wrote on last edited by
              #27

              The one problem I have with the everything-on-one-line approach style of programming (which I also do a lot) is that it's impossible to debug. You don't get intermediate values and you don't get to set breakpoints at specific functions. The readability aspect is not that big of a deal, I can read it just fine (usually). However, since you write code only once and read and debug it a gazillion times I prefer to write my code so I can step through it. Sometimes I put it back together for readability afterwards. For example:

              // Debuggable
              var filtered = myList.Where(...);
              var ordered = filtered.OrderBy(...);
              var result = ordered.ToList();
              return result;

              // Readable
              return myList
              .Where(...)
              .OrderBy(...)
              .ToList();

              Best, Sander Continuous Integration, Delivery, and Deployment arrgh.js - Bringing LINQ to JavaScript Object-Oriented Programming in C# Succinctly

              K 1 Reply Last reply
              0
              • R RandyBuchholz

                This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

                // Not me
                string Foo(int x)
                {
                if(x == 1)
                {
                return "one";
                }
                else
                {
                return "not one";
                }
                }
                }

                // sometimes me
                string Foo(int x){
                if (x == 1) {
                return "one";
                } else {
                return "not one";
                }
                }

                // usually me
                string Foo(int x) => (x == 1) ? "one" : "not one";

                // often me
                string Foo(this int x) => (x == 1) ? "one" : "not one";

                I do things like this. (Not really this weird though :)).

                public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
                public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
                public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

                So I can write in sentences

                var list = new List {"a", "Hello", "c"};

                list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

                Instead of paragraphs. (something like (methods would be a little different))

                var list = new List {"a", "Hello", "c"};
                if(list.count > 0){
                foreach(var i in list){
                var (condition, temp) = Prepare(i);
                if(condition != null){
                Manipulate(temp);
                }
                }
                }

                Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

                K Offline
                K Offline
                KBZX5000
                wrote on last edited by
                #28

                This I can parse and validate, at a glance, without trying:

                string Foo(int x)
                {
                if(x == 1)
                {
                return "one";
                }
                else
                {
                return "not one";
                }
                }
                }

                This requires me to actually read the words on screen and consciously think about them:

                string Foo(this int x) => (x == 1) ? "one" : "not one";

                It's not "more clear" on a macro level. It's "more clear" to you personally. If you were one of my juniors, I'd reprimand you for using an esoteric personal style at work. If you were a senior colleague, I'd just skip all formalities and just stab you with a kitchen knife. :)

                K 1 Reply Last reply
                0
                • L Lost User

                  missing a close brace in your first // sometimes me example. and yeah, sometimes I do the same with similar (obvious) crap.

                  This internet thing is amazing! Letting people use it: worst idea ever!

                  S Offline
                  S Offline
                  S Houghtelin
                  wrote on last edited by
                  #29

                  Lopatir wrote:

                  missing a close brace in your first // sometimes me example.

                  Definitely me sometimes. :laugh:

                  It was broke, so I fixed it.

                  1 Reply Last reply
                  0
                  • S soulesurfer

                    In your example:

                    list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

                    The WhenNotEmpty()?. isn't really needed, is it?

                    R Offline
                    R Offline
                    RandyBuchholz
                    wrote on last edited by
                    #30

                    No, not really in this case. Something like `.When(predicate)` that might have been better. Or following it with something where it did matter.

                    S 1 Reply Last reply
                    0
                    • R RandyBuchholz

                      No, not really in this case. Something like `.When(predicate)` that might have been better. Or following it with something where it did matter.

                      S Offline
                      S Offline
                      soulesurfer
                      wrote on last edited by
                      #31

                      I was saying that you can use an empty collection with foreach, which will basically do nothing. You shouldn't need anything there.

                      R 1 Reply Last reply
                      0
                      • S soulesurfer

                        I was saying that you can use an empty collection with foreach, which will basically do nothing. You shouldn't need anything there.

                        R Offline
                        R Offline
                        RandyBuchholz
                        wrote on last edited by
                        #32

                        Right. That's what I meant by "following it with something that did matter".

                        1 Reply Last reply
                        0
                        • Richard DeemingR Richard Deeming

                          Marc Clifton wrote:

                          a list should never be null

                          There's one feature of C# 8 you'll like, then! :) csharplang/nullable-reference-types.md at master · dotnet/csharplang · GitHub[^]


                          "These people looked deep within my soul and assigned me a number based on the order in which I joined." - Homer

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

                          Richard Deeming wrote:

                          There's one feature of C# 8 you'll like, then!

                          Quite so. Still, I wonder where they're going with this -- nullable value types are great, and so it makes sense that the complement, non-nullable reference types, should exist, it certainly provides symmetry. But oh boy, there are going to be thousands of warnings in the code base I work with at work when (if ever) they opt-in for this. But it'll probably be a few years before they get their build systems onto the C# 8, which by then they still will probably be several versions behind, as they are now. :^)

                          Latest Article - Building a Prototype Web-Based Diagramming Tool with SVG and Javascript 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

                          1 Reply Last reply
                          0
                          • R RandyBuchholz

                            This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

                            // Not me
                            string Foo(int x)
                            {
                            if(x == 1)
                            {
                            return "one";
                            }
                            else
                            {
                            return "not one";
                            }
                            }
                            }

                            // sometimes me
                            string Foo(int x){
                            if (x == 1) {
                            return "one";
                            } else {
                            return "not one";
                            }
                            }

                            // usually me
                            string Foo(int x) => (x == 1) ? "one" : "not one";

                            // often me
                            string Foo(this int x) => (x == 1) ? "one" : "not one";

                            I do things like this. (Not really this weird though :)).

                            public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
                            public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
                            public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

                            So I can write in sentences

                            var list = new List {"a", "Hello", "c"};

                            list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

                            Instead of paragraphs. (something like (methods would be a little different))

                            var list = new List {"a", "Hello", "c"};
                            if(list.count > 0){
                            foreach(var i in list){
                            var (condition, temp) = Prepare(i);
                            if(condition != null){
                            Manipulate(temp);
                            }
                            }
                            }

                            Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

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

                            Your first example has one great advantage: When your productivity is measured in number of code lines produced, it wins by a large margin. The disadvantage is that to get an overview over even a fairly trivial function that really should fit in a screenful, you have to flip back and forth though a pile of pages. In any sufficiently fancy editor you can split the window so you can correlate various parts of the function logic, but then you can fit half as much logic in each tile, and that may be too little! A second disadvantage: With all that whitespace (frequently, programmers add at least one blank line before and after every loop, after function initialization, ... everywhere!), you have to look really close to see where this function ends and the next function starts. Except that those blank line lovers usually also add a huge comment block before every function to explain that ThePriceOfApplesPerKilogram argument is the price of apples per kilogram, that pi has the value of 3.1415926535897932384626433 and similar essential information. To some of these programmers, "readability" is a synonym for "whitespace percentage". Sort of homeopathic programming: The more diluted, the more powerful. On the other hand: The APL ideal of "There is no programming task so complex that it cannot be solved in a single line of APL" goes too far for my taste. An example from Wikipedia -The game of Life: life←{↑1 ⍵∨.∧3 4=+/,¯1 0 1∘.⊖¯1 0 1∘.⌽⊂⍵} I put most regex in the same category. Geek & Poke: Yesterday's regex[^] I'd like to place myself in the middle of the road, but I cannot deny that those homeopatic programmers raises such protests in me that I lean somewhat over to the other side. If you cannot fit every function in its entirety on a single screenful, then you have used too much whitespace.

                            1 Reply Last reply
                            0
                            • K KBZX5000

                              This I can parse and validate, at a glance, without trying:

                              string Foo(int x)
                              {
                              if(x == 1)
                              {
                              return "one";
                              }
                              else
                              {
                              return "not one";
                              }
                              }
                              }

                              This requires me to actually read the words on screen and consciously think about them:

                              string Foo(this int x) => (x == 1) ? "one" : "not one";

                              It's not "more clear" on a macro level. It's "more clear" to you personally. If you were one of my juniors, I'd reprimand you for using an esoteric personal style at work. If you were a senior colleague, I'd just skip all formalities and just stab you with a kitchen knife. :)

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

                              Do you really have parsing problems with

                              string Foo(int x) {
                              if (x == 1) return "one";
                              else return "not one";
                              }

                              This style gives me a third as many source "code lines" to relate to. I can easily overview the entire function. In a larger function, a less whitespaced layout makes it much easier to spot the start/end of loops and condition blocks etc.

                              K 1 Reply Last reply
                              0
                              • Sander RosselS Sander Rossel

                                The one problem I have with the everything-on-one-line approach style of programming (which I also do a lot) is that it's impossible to debug. You don't get intermediate values and you don't get to set breakpoints at specific functions. The readability aspect is not that big of a deal, I can read it just fine (usually). However, since you write code only once and read and debug it a gazillion times I prefer to write my code so I can step through it. Sometimes I put it back together for readability afterwards. For example:

                                // Debuggable
                                var filtered = myList.Where(...);
                                var ordered = filtered.OrderBy(...);
                                var result = ordered.ToList();
                                return result;

                                // Readable
                                return myList
                                .Where(...)
                                .OrderBy(...)
                                .ToList();

                                Best, Sander Continuous Integration, Delivery, and Deployment arrgh.js - Bringing LINQ to JavaScript Object-Oriented Programming in C# Succinctly

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

                                All that depends on the debugger. E.g. in Visual Studio, if you write your code as

                                string Foo(int x) {
                                if (x == 1) return "one";
                                else return "not one";
                                }

                                and you only want to break when "one" is returned, mark the statement return "one"; with the mouse and hit F9. It will not break for the "if" tests, but only if the true branch is taken.

                                Sander RosselS 1 Reply Last reply
                                0
                                • K kalberts

                                  All that depends on the debugger. E.g. in Visual Studio, if you write your code as

                                  string Foo(int x) {
                                  if (x == 1) return "one";
                                  else return "not one";
                                  }

                                  and you only want to break when "one" is returned, mark the statement return "one"; with the mouse and hit F9. It will not break for the "if" tests, but only if the true branch is taken.

                                  Sander RosselS Offline
                                  Sander RosselS Offline
                                  Sander Rossel
                                  wrote on last edited by
                                  #37

                                  Yeah, but I believe that's a new feature since VS2017 :) Just like you can now debug in-line lambda's. It wasn't always like that (and still sometimes isn't).

                                  Best, Sander Continuous Integration, Delivery, and Deployment arrgh.js - Bringing LINQ to JavaScript Object-Oriented Programming in C# Succinctly

                                  1 Reply Last reply
                                  0
                                  • J Jacquers

                                    I prefer funnels ;P [Modern Art: The Funnel - The Daily WTF](https://thedailywtf.com/articles/modern-art-the-funnel)

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

                                    IOCCC, the International Obfuscated C Code Contest (International Obfuscated C Code Contest [^]) often have some beauties, not only in obfuscatedness but also in code layout.

                                    1 Reply Last reply
                                    0
                                    • R RandyBuchholz

                                      This was inspired by Marc Clifton's post [Dumbing down code so it can be maintained by junior devs](https://www.codeproject.com/Lounge.aspx?fid=1159&fr=126#xx0xx) I'm a horizontal programmer. I write chainable methods with (short) descriptive names. The top of my methods usually consists of a few "sentences" composed of these "words". If I can put my code on one line, (braces, etc.) I usually do. Eg, simple method:

                                      // Not me
                                      string Foo(int x)
                                      {
                                      if(x == 1)
                                      {
                                      return "one";
                                      }
                                      else
                                      {
                                      return "not one";
                                      }
                                      }
                                      }

                                      // sometimes me
                                      string Foo(int x){
                                      if (x == 1) {
                                      return "one";
                                      } else {
                                      return "not one";
                                      }
                                      }

                                      // usually me
                                      string Foo(int x) => (x == 1) ? "one" : "not one";

                                      // often me
                                      string Foo(this int x) => (x == 1) ? "one" : "not one";

                                      I do things like this. (Not really this weird though :)).

                                      public static List WhenNotEmpty(this List item) => (item.Count > 0) ? item : null;
                                      public static string Prepare(this string item, out string prepared) => ((prepared = item + "Appended") == "HelloAppended") ? "ok" : null ;
                                      public static void Manipulate(this string item, string stuff) => Debug.WriteLine($"{item}:{stuff}");

                                      So I can write in sentences

                                      var list = new List {"a", "Hello", "c"};

                                      list.WhenNotEmpty()?.ForEach(s => s.Prepare(out var r)?.Manipulate(r));

                                      Instead of paragraphs. (something like (methods would be a little different))

                                      var list = new List {"a", "Hello", "c"};
                                      if(list.count > 0){
                                      foreach(var i in list){
                                      var (condition, temp) = Prepare(i);
                                      if(condition != null){
                                      Manipulate(temp);
                                      }
                                      }
                                      }

                                      Getting to the point, (finally :zzz: ) The paragraphs approach is clearer at the micro level (the details are clear), but the sentences is clearer at the macro level (the overall intent is clear). Of course you can wrap this paragraph in a method. But when you don't: Do you tend to write more at the macro/sentence level or micro/paragraph level?

                                      B Offline
                                      B Offline
                                      Bruce Patin
                                      wrote on last edited by
                                      #39

                                      This is the first time I have seen "this" being used to prefix a parameter, and Googling doesn't find it. Could you explain, please?

                                      R 1 Reply Last reply
                                      0
                                      • B Bruce Patin

                                        This is the first time I have seen "this" being used to prefix a parameter, and Googling doesn't find it. Could you explain, please?

                                        R Offline
                                        R Offline
                                        RandyBuchholz
                                        wrote on last edited by
                                        #40

                                        Check out [Extension Methods (C# Programming Guide) | Microsoft Docs](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/extension-methods)

                                        B 1 Reply Last reply
                                        0
                                        • K kalberts

                                          Do you really have parsing problems with

                                          string Foo(int x) {
                                          if (x == 1) return "one";
                                          else return "not one";
                                          }

                                          This style gives me a third as many source "code lines" to relate to. I can easily overview the entire function. In a larger function, a less whitespaced layout makes it much easier to spot the start/end of loops and condition blocks etc.

                                          K Offline
                                          K Offline
                                          KBZX5000
                                          wrote on last edited by
                                          #41

                                          I can parse it line by line at a normal reading speed. Takes about 3-4 seconds the first time I see it. The initial style I can parse and verify without having to read a single word. Takes me about 250 milliseconds. The benefit of having spacious functions is that mistakes become embarrassingly easy to spot. Likewise, properly written functions become very easy to parse, because they look so damn familiar. I find "less lines of code" a dubious benefit. A cramped style is more time-consuming to debug, both in terms of setting breakpoints and retracing logged exceptions. Also, I definitely agree functions should not grow too big.. but stacking multiple logical steps on a single line only gives you the illusion of small functions. I say: be spacious, let functions grow, and flag them for refactoring if they don't fit on a single page. The point is to write code that's self-evident +6 months in the future. Quick to read, amend and fix if need be.

                                          K 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