Skip to main content

Intuitive Programming - to Class or not to Class

Reading code is only easy in trivial systems and a system that has a lot of functionality usually has a lot of code.  Reading code is a critical part of what software developers do every day so it makes sense to make reading code easier by making the code more intuitive to the largest population of programmers.

There are books and numerous articles on software design, patterns and naming conventions.  I encourage everyone to read those, this blog post is not an attempt to create and exhaustive guide to writing good code.  Here I am going to cover a few small hacks that help people understand what your are doing faster.  The first topic of discussion is classes.

When I started programming in 1990s Object Oriented Programming (OOP) was all the rage.  After 25 years I have noticed that software field has fashionable trends where “everything must be so”, so in 1990s a lot of people were into C++ and Java (today the fashionable thing is micro services). Objects and classes were not invented in the 90s but they definitely were “the way” if you wanted to write your code “the right way”.

Java took OOP to an extreme and required you to have a class for every function.  This took out an important signal from what we got from classes.  In software development adding unnecessary stuff is second worst to not having enough necessary stuff.  In order to figure out what people’s intuition tells them about functionality that is in a class let’s examine what what classes do for us:
- Classes allow us to have data or context with functions, so that consequent calls to functions that belong to the same class maintain that context.  This is done through “this” or “self” reference (or pointer).
- Classes give us an ability to pass a set of functions together that all comply to a signature but could be implemented in a variety of ways and possibly even different way depending on which object is being passed around.  This is done through virtual function table (vtable).

When choosing to use a class as opposed to a function with parameters the programmer is signaling to the readers: I have some context or some functionality that needs to travel together. If you use classes only when you need class functions it’s a wonderful way to signal to the reader that the context is important.

Unfortunately I see code writers who have grown up on OOP overuse classes and interfaces so the code readers then have to look inside of the class to see whether or not there is data or implementation context that is relevant here.

Simple functions don’t carry context around, by using them your tipping off the readers intuition that there is no context here outside of the parameters being passed in and return values (caveat are global variables and data storage, but that’s a separate topic).

The resulting rule of thumb is to keep it simple unless it needs to be more complex and in languages that support both functional and object oriented programming - use functions unless context or interface/implementation decoupling is necessary.  In places where you kept things simple the readers will be able to use their intuition and decrease their cognitive load.



Popular posts from this blog

SDET / QA Engineer Interview Checklist

After interviewing and hiring hundreds of engineers over the past 12+  years I have come up with a few checklists.  I wanted to share one of those with you so you could conduct comprehensive interviews of QA Engineers for your team. I use this checklist when I review incoming resumes and during the interview.  It keeps me from missing areas that ensure a good team and technology fit.  I hope you make good use of them.  If you think there are good questions or topics that I have missed - get in touch with me! SDE/T or QA Engineer interview checklist from Mike Borozdin If you like this checklist you might want to check out these posts: Emotional Intelligence in Software Teams   and  Good-bye manual tester, hello crowdsourcing!

Code versus Configuration

At Ethos we are building a distributed mortgage origination system and in mortgage there is a lot of different user types with processes that vary depending on geography.  One of our ongoing discussions is about how much of the logic resides in code vs. being in a workflow system or configuration.  After researching this topic for a bit, I have arrived at a conclusion that the logic should live outside of code very infrequently, which might come as a surprise to a lot of enterprise software engineers. Costs of configuration files and workflow engines First thing that I assume is true is that having any logic outside of the code has costs associated with it.  Debugging highly configurable system involves not only getting the appropriate branch from source control, you also need to make sure that the right configuration values or the database.  In most cases this is harder for programmers to deal with.  In many FinTech companies where the production data is not made readily acce

Intuitive Programming - Comments

Comments are a topic of vibrant discussion.  Ever since programmers could leave some text in the program that was ignored by the machine the debate started: “what’s a good comment, what’s a bad comment, why comment?” There are endless instructions to programmers that say many of the following things: 1) Describe your function! 2) Don’t write in the comment what you wrote in the code. 3) Tell people why you are doing what you are doing. What I think has been missing from this discourse is the audience for comments and through those audiences there is intent.  The code is being read, skimmed or analyzed by people and tools.  So what are the audiences and reading modes? 1) Maintaining and enhancing the code 2) Skimming through the entire module or file to figure out what the overall structure is 3) Reviewing the test files to check out the test coverage and edge cases 4) Seeing the docstrings of functions while being in a separate file altogether 5) Reviewi