Why Coding Standards Aren't Only For the Anal-Retentive
February 07, 2019
Labels: Coding, Coding Standards, ES Lint
No one likes a mess.
Have you ever tried to make sense of someone else's notes and just been completely lost? Which of these
would you rather
read?
I'm guessing you picked the one on the right. When I taught Algebra 2, I was constantly looking over
students notes and
work to help them solve problems. I noticed a significant difference in students who kept their work
neat versus those
who just scribbled numbers here and there on their paper. First of all, when I asked a student to
explain their thinking
process to me, those who had a system for showing their work could easily walk me through, step by step,
which made it
easy for me to point out any errors to them. Those who did NOT solve problems systematically would often
get lost trying
to explain their process to me and would have to start from scratch. It made such a difference that I
started requiring
students to follow certain guidelines when solving equations. You can look at coding in a similar light.
You are going
through a logical series of steps to achieve your end goal. So, it naturally follows that coders would
also benefit from
adhering to some type of standard for "showing their work" as well.


So get it together

Long Story Short
The moral of the story is, if you hate your coding standards right now, ***stick it out.*** It’s worth
it in the end.
For you and any other poor soul who has to read through your code in the future.
\**If you think I feel strongly about this, wait till you hear what I have to say about commenting your code.* 😄
\**If you think I feel strongly about this, wait till you hear what I have to say about commenting your code.* 😄