please please separate logic from implementation - a way how to make our code easy to understad

 How many hours I spent on decoding stuff that does not need to be decoded... We are reading and repeating decode every time we see piece of logic.

On snippet above we can see just an if statement and 4 different logic cases to be resolved. Our brain will try to imagine all the string details before will enter inside the execution block. Can we help our brain to work faster? Sure we can do it!

  1. let's name first logic case as var johnBlogEntryCode =  a.Length>15 && a.Contains("11") 
  2. the second one as var maryBlogEntryCode = a.Length<20 && a.Contains("2")
  3. and finally var doWeHaveOurBlogEntries = johnBlogEntryCode | maryBlogEntryCode

How that looks now for you?


I can bet an old fart that you just read stuff on the left and not go into details on the right - true?

This is one of the simple but CHALLENGING methods when we need to understand what are we doing in a particular piece of code an NAME IT! 

 



As we can see on the screenshot there is very little penalty for CPU when making code better for humans :D.

A challenge for you for today: Find an if statement and remove logic to helper variable!

Have a good day!






Comments

Post a Comment

Popular posts from this blog

when a new guy joins a team...

Image
Not so long ago, I was browsing merged pull requests to check quality of the work that was done. I don't know why, but in 202X C# is rather a modern language and some language syntax shall be adjusted to newer standards. When I was starting my developer journey - I was told to always add a code that looks similar to the one that already is there, unless it is total crap and adding new stuff needs more effort today, to not to die tomorrow. But in this case, we have a project that is created in in 202X and there is a lot of good looking and working lines of code around, so anyone can follow it. First time, when I was a student and helped my colleague, I was in shock that the teacher recognized my help, I turned all red and asked him "how you were able to recognize that?". He said that most of us have a kind of style that identifies us as developers, so this is spacing, the way how we organize braces (even when autoformated), how we write and solve problems,  and finally var
Read more

FizzBuzz - my first interview task on whiteboard

Image
 I think we all know the FizzBuzz task, when we a function shall print fizz if the number is divided by 3, buzz if by 5 and fizzbuzz when by both. Yesterday I did a small research about how many different implementations we can have using C# and there were many. Ones looks very common with "if"   statement tree, some of them were using LINQ and looking hard to understand what is going on in a first instance. StackOverflow has this one question with a bunch of examples  Writing FizzBuzz , that I will use to check how those solutions work from a performance perspective, code complexity and human understanding. listing 1 fizzbuzz question As we can see, OP introduced a tuple to solve the problem, which in my opinion gives a lot of opportunists for extensions with a little code changes.  The metric looks good, but if we move the list declaration outside the function (so it is not recreated every time the function is called we shall be good) To do benchmark I will convert
Read more

are YOU a garbage collector?

Image
 If I will ask you: "Are you a garbage collector" - I bet I will hear: " NO ", so I ask you: show me your code.... It is unbelievable that so many developers are pushing changes with commented out code, because  there could be a chance to re-use that piece. In fact that time never comes to me and the lines stays there forever. Clean code means no rubbish commented code - we have git to remember that for us. Now, when you need to comment a few lines in a row... there are better solutions, but if someone is lazy and slumsy then we can see diffs on code review like that: Now this is a mystery for me, when I am able to see that this is going to the main branch as the guys who is called code reviewer is there only to click Approve -  I am truly believing that it is not you my reader. I need to admit that, when I was a kid, together with grandma we were collecting garbage as a way to get some $$ for a life and then every piece we found had a material value and were able t
Read more