First And Most Important Lesson To Writing Good Code

I made a lot of mistakes in my first 6-12 months as a developer in the industry and learnt a lot of new habits the hard way. This one in my opinion is by far the most important! I found I had a good level of competence learning new technologies and h...

paddockson.hashnode.dev4 min read

#career #learn-coding #csharp #clean-code #programming

Responses1

Markdown supported · ⌘↵ to post

Art Stępkowski

Sep 15, 2021

Are you sure that:

            if (newLevelOfHappiness == maxHappiness)
            {
                return true;
            }
            else
            {
                return false;
            }

is an example of clean code?

Matt Paddock

Please don't ever give up or give In.

Sep 15, 2021

As the post was written for people starting into the industry this is an example of clean code. You could argue this is cleaner:

         private bool test(int x, int y)
        {
            if (x == y) return true;

            return false;
        }

But this not as readable for someone who may have 0 experience in the industry and self taught. Separation of methods, naming and unnecessary code was mostly the point around this, being the SOLID principles as a developer.

If you prefer I can update this with more advanced understanding to keeping methods clean.

Art Stępkowski

Sep 15, 2021

Matt Paddock

No, this isn't example of clean code. It's antipattern.

if(expression) {
  return true;
}
else {
  return false;
}

You second proposition is still the same antipattern. From my point of view, teaching antipatterns is wrong. Any live coding session will be a disaster for begginer with bad habits. Writing a code like this, during a job interview, is a red flag for me.

Proper (clean) version of IsHappy function should look like this (2 is magic number and should be moved to const).

        public bool IsHappy(int levelOfHappiness, int maxHappiness)
        {
            return levelOfHappiness * 2 == maxHappiness;
        }

Teaching SOLID principles is great (I know senior devs with problems with it), but do you really think, that refactoring lesson is good for absolute begginers? To refactor code one should know a little bit more about coding than pure basics.

Search Hashnode

First And Most Important Lesson To Writing Good Code

Responses1