The art of readable code – review
I’m not sure whether we can call this blog post as review or summary of a book. After reading please decide yourself which name suits very well.
Book Name : The Art of Readable Code
Authors : Dustin Boswell and Trevor Foucher
The book has been divided into 4 parts
- Surface-level improvements
- Simplifying loops and logic
- Reorganizing your code
- Selected topics
And then each parts discussing various important topics in details in the entire book.
Every chapter starts with a cartoon image which is fun and loads with deep meaning related to the topic. The cartoon image gives a quick view on what information the entire chapter had in it.
The ultimate aim of this book is to discuss about “how we can make code more readable”. So that whenever we revisit our own code, we don’t have give a alien look to our code editor.
The author mentioned in the book as the goal is “to minimize the time
it takes someone else to understand your code.”
Part – I: Surface Level improvements
The topics under this part will help us make a small level changes in the code line by line which will results in a big form. The topics like choosing better name for variable & function names, writing more understandable comments, using common formatting for code across team are covered under this section.
My favorite topic under this part is loading information with names – like adding units in the arguments of a function, using concrete names.
Adding proper comment to the proper place in a proper way is a winning policy for every successful coder. (+ commit logs :)) There is no specific length for a good comment or log message, the message should precise and compact.
Part – II: Simplifying loops and logic
I have started my coding career by learning basic loops and logic. The various topic under this part is like revisiting our own memory and brush up some basic understanding of loops & logic.
The large number of variables, complicated loops, and giant expression in our code will create great confuse in our mind while going through the code for understanding. This part discuss various topics on how we can make our loops more readable. If loops looks so complicated, the bugs may likely go unnoticed. Sometimes our complicated loops will play Three-card monte trick with us.
My favorite topic under this part is shrink the scope of the variables. Too much global variables will create pretty good confusion at its best.
Part – III: Reorganizing your code
Topics under this part discuss about the functional level changes in our code – Extracting “unrelated sub problems”, Rearranging the code so that one task happening at a time, turning thoughts into code.
The ultimate aim of this part of code is to separate the generic code from the project specific code, and also to improve reusable of the code.
“Each new line of code needs to be tested, documented, and maintained. Further, the more code in your codebase, the “heavier” it gets and the harder it is to develop in.”
Part IV: Selected topics
In this part, author discussed about testing – how to write tests that are effective and readable at the same time.
Too long to read
Its really a nice book, I would like to recommend to all the people in Software field (especially young developers). Some of the Experienced people may already have more insight on above topics by gathering knowledge from their years of experience. We won’t accept some of the suggestions in the book, if we discuss these topics with our team we can get into more interesting discussions.
Happy reading 🙂