Okay - first things first... I am in no way anti clean code, and I'm not saying it is necessarily a bad thing.
However... in recent years it seems to be becoming more like a religion - with overzealous 'experts' preaching it to the young faithful as the 'one true gospel', and condemning those who dare to speak against it as heretics. This is more like a cult, and is profoundly unhealthy for our industry.
But, isn't 'Clean Code' a good thing?
Yes, and no... depending on what you take it as meaning.
The word 'clean', in relation to code quality is obviously subjective and can mean wildly different things to different people - but I think we can all agree that the core of what is intended is:
Code whose purpose is clear to most who read it.
If we leave it there, that is a noble goal and will have many obvious benefits.
'Clean Code' starts to become a problem when its proponents treat it as a series of dogmatic commandments, rather than as a 'pirate code' that is more like 'guidelines'.
Why is this lowering developer quality?
Well... and this is just my personal theory - it seems to have created a mentality where:
The code should be understandable by the most junior dev in the team
I've actually heard this said in some places I've worked, and I've seen similar sentiments echoed online by 'expert' tutors. But, just think it through... if we adhere to this mentality then everything becomes a race to the bottom. We would actively seek to dumb down code to the point where it is more like an introductory reader for a five year old, than an elegant, nuanced work by a master author.
Advanced concepts in languages are deemed 'too difficult' or 'esoteric' without explaining anything about them - they're just swept under the carpet, or filed under 'do not use'. The overall result is a shrinking knowledge of the languages, and of programming techniques and concepts in general. If an indoctrinated new developer comes across any of the 'forbidden' items, they will often dismiss it as bad code and may even seek to replace it with something 'better' that adheres to the clean code commandments - sometimes unwittingly sacrificing objectively faster, more efficient, flexible code with something inferior.
The scary thing here is that the new developers do not know what they lack. They then become senior, and start preaching the same 'correct way' to the next crop of inductees - perpetuating and compounding the problem.
How do we fix this?
I think the best way is to change the way people are learning to code. We need to move away from 'you too can be a developer in 3 days - here's how' type tutorials that jump straight in there and show you how to do specific things in specific ways, and move back toward teaching people about the languages themselves, their features, and how to use them to convert your thought processes into functioning programs. The next step would be encouraging people to build for themselves - based upon what they've discovered and learned. After this they will be well versed in how things work and at a great point to start understanding existing codebases in their own way, and evaluating for themselves (maybe with some guidance) which techniques are better suited to different situations. Learning in this way will bring a much fuller understanding - resulting in much more competent, and - more importantly - creative developers.
To make an analogy, I believe modern teaching of software development has become too much like modern Lego; it used to be that you just had a huge tub of bricks, and you used your own ingenuity and inquisitiveness to firstly work out how all the pieces 'work' and fit together... then use your imagination and creativity to build the things you wanted to build. Nowadays, it's all single Lego sets with specific instructions, movie tie-ins etc. The instructions are followed unquestioningly, everyone builds the same 'cool' things. The joy and benefit of learning and creativity is lost - replaced with the instant gratification so desired in modern convenience culture.
Let's stop the rot, and bring back to software development what is being lost:
- Joy
- Curiosity
- Discovery
Cover illustration courtesy of Danny Sapio
Top comments (31)
TL:DR
You're right, if you preach about clean code instead of thinking through proper solutions, you're off worse than getting stuff done. But that doesn't mean you should be careless about aesthetics. Code is read by people and interpreted by a machine. Nobody likes to read a badly written article, why would devs like to read badly written code? Even if they have to, don't you think it'd lower their performance more than a clean codebase?
There are a few things I find very enlightening here and some I just can't agree with.
Isn't this a good thing? The best books I've ever read were the ones I could easily digest while learning a lot (e.g. Books by Kahnemann or Carnegie). You're right with one thing - it takes time, patience and practice to write code that just works, it just doesn't stop there. If I was presented two codebases
I'd always scrap 2 and move on with 1. Refactoring imo is more fun (and often less time consuming) than debugging.
Again, not saying being creative is a bad thing per se. But try to imagine
Taking over responsibility, you'll jump into the codebase trying to grasp what's going on. You see one module by dev#2 looking like that (pseudocode to extract mandatory build steps for a database schema, based on a true story):
In another universe, your other, but slightly luckier you, is confronted with the same problem. With a difference in the codebase:
There's a few obvious differences:
What makes the second, class based approach superior to the module implementation is:
Both times, the code probably works. And some people might say: "What's wrong with code 1? It does the job, doesn't it?".
Sure. But be honest. Put yourself into the world of the poor lead developer who has to jump into the breach whenever shit hits the fan. Once you're confronted with the code: Which approach would you prefer - Quick & Dirty OR well thought & aesthetic?
I'd disagree with your assertion that the second snippet is (slightly) better; it is, in my opinion, more complex in its structure, whereas the first snippet only seems more complex because of the poorly named variables and some sub-optimal choices of syntax.
This sort of problem is usually easy to clean up by just renaming the variables to what they represent (
cmd
โcommands
,ct
โcounter
, etc.) and tweaking the code to use more readable syntax (for ... in
โfor ... of
, not mixingfor
loops withforEach
for a nested loop, etc.)Meanwhile the second snippet of code obfuscates its intention much more deeply with its program structure. A function is hidden behind a stateless class (instant red flag), trivial actions (increasing a counter) are extracted into separate subroutine, but it hides these flaws by having more descriptive variable names, so it seems "friendlier" to the reader.
I think you may have misunderstood me somehow. In no way did I suggest being careless about aesthetics
I wasn't so sure here, might as well be a misinterpretation from my side.
On the one hand, you mention 'elegant, nuanced work', on the other hand, to quote:
I'd interpret this statement as a call to action for a trial and error approach. It works fine. Just in my experience, just as often it leads to the 1st scenario I described above (working, but 'ugly' code). Which still isn't a problem until the first change request hits.
Since I have an econ/business'ish background, I've got two hearts beating in my chest. Be diligent AND done in time/budget. Which is extremely hard to achieve. Uncle Bob got me with one statement though.
Yup, really seems like we're not on the same wavelength
what did I just read?
Interesting topic, I enjoy reading controversial articles, they help me expand how I see coding.
To me, clean code has more to do with the question "Will I be able to understand this piece of code in 6 months time?". Often, it's okay to break the rules.
I mostly agree with this statement. Do we write code for clarity, or to show off how much we know about a language? My philosophy is that simple is always best. I think the meaning behind that is to say that there's no need to write overly-engineered code when you can just keep it simple.
I agree with you that learning how to code takes a lifetime. There is not set period to learn "coding", it's just never-ending.
The instant gratification you mentioned (meaning, "Learn How To Code Within X Days/Week) is a business thing, in the same way people buy programs promising them to get abs within 6 weeks (it's the same logic).
Oh, this always bugs me. No, advanced or more complex code isn't "showing off". It's brevity. It's using the language's features. There's wide gaps between "write so simple everyone understands it", "write concise code that leverages the language's tools to the fullest" and "lolcodegolf", and we should certainly aiming for a solid balance of these.
(In fact, sometimes code golf is actually the right answer, but that's a bit beside the point...)
It often performs better too
I agree with you, a 100%. I do believe we should use the language features whenever appropriate. My concern is more with those who write over engineered code.
Another problem is that too often 'simple' is confused with 'simplistic'
Good post!
This is definitely something I also agree with. Since I started learning to code all I see is "how to become a developer in X days/weeks" and they all tell you to learn a whole language in like 1-2 weeks... I have been learning the same language for months... am I doing something wrong? ๐ But my approach has always been, try to learn how things work to understand as much as possible.
Carry on like that. It really is the best way
I have some issues with this. Say 5 years ago I would have fully agreed with you on this topic. Clean code for me was defined:
1) does what it says without surprises (mostly surprising side-effects)
2) is easy to read for everyone fluent in the language
3) is careful with used ressources ~ "efficient"
I think so far we are on the same page.
But I changed my attitude towards (2).
I agree upon that is not the goal to have. But today I would say
2) is easy to read for everyone in the audience
Which is a small change, but with an interesting impact:
Say you are working with a high skilled team there is no reason to hold back some knowledge. You are fluent in x so use it up to its full potential.
If you are publishing your code for your own behalf there is no reason anyway to hold back knowledge.
But if you are working on a team where others have to read your code the mentality of "when you do not understand quality code you are a low quality developer" does help nobody it only feeds your ego. The problem is not having a low quality team but you being a blocker in the team, because you cause extra work. I changed my perspective due to an experience where I supported another senior developer getting his project out of the door. The project was overdue. I knew newer language features the other did not at the time. So it was natural for me to put my knowledge to work. But what happened? I wasn't there when my code broke and he had to fix it. Instead of fixing the code right away he was forced to learn the new language features.
Of course you could argue with educational debt on the companies side - and you would be quite right with that - but this is of no help, when you are in a hurry to to fix just a simple bug.
So: Yes, it would be easy to blame "low quality developers", but it doesn't help the team. Sometimes there is even no time or money to educate your team.
Write for your audience - and if you are the only senior then it would be better for the team you write junior level code than to foce every other developer to adapt to your level. If that feels wrong, maybe you are in the wrong team?
Yup, it's a fine balance... but in recent years I do feel the balance is being lost - at least in places where I've worked
There are some good points in this article. Specifically, I agree that many new developers know how to do some things (by doing tutorials) but lack the understanding of the why.
Moreover, we need to let developers think through things for themselves.
It is a complicated problem with that no black-and-white solution will fix.
My suggestion would be that we have clear standards for junior developers to follow. Letting them go off an do their own thing won't really invoke creativity but a mess. There is a period of time where they just need to trust and absorb from others more experienced. As they mature, you can allow them to be more influential on coding standards, let them think on their own. You may even want to have a supplementary codebase, or a portion of the codebase, that it more lack to see what those developers come up with apart from the current standards.
Order and consistency in a codebase is more important than anything. However, the focus of clean code should be to the end of reducing complexity, which may or may not improve readability--often it does.
In a word, clean code almost always will provide higher code quality than no coding standards. However, that does not mean that there aren't some gaps that we have to be intentional to fill in to get the most from it.
41:00: "so most teams actually like the idea of normalizing in fact some of them like it too much where if you have a creative idea of doing things differently, โoh I don't want to rock the boat, I don't want to do my own thing here or go off the reservationโ, so instead we tend to just gravitate towards the lowest common denominator on a lot of teams and that's not goodโฆ"
I saw an interesting, very accurate post on a similar topic today:
positech.co.uk - Code bloat has become astronomical
I have to be honest, by seeing this title I first thought you were talking about the clean code architecture by Uncle Bob lol.
Regardless, you are quite on point through this whole post. For example, I have recently been working on a project which tries its best to do abstraction. But through trying to make sure the project has "Clean Code" it has been over abstracted through and through such that you cannot have people comfortably settle into the project or even comfortably make changes.
Clean code is not about abstraction and he who promoted that in your poor codebase should indeed read uncle bobs book(s). Its about maintainability and leveling your codes intent with the amount of abstraction you possibly introduce. People are so black and whlte its scary.
The red green refactor is a good tool in clean code. Make it work, then make it read better. Then when someone else makes changes, they do the same. Code should be possible to be used in discussion, hencr hiding an ugly for loop in a function makes sense (get filtered posts function speaks better than the for loop on line 13 where we filter posts, for an example)
Other abstractions like factories, visitors and observer, these are terms that lets people talk about code like you and me can talk about cars, drivers and mechanics. We all know the meaning without having to describe how each one works in the world esch time it is mentioned.
These are, imo, the main intents of clean code. Using these methods any senior dev can use any language features as much as he wants to leverage it for performance. If he actually is good, that is ;)
A great read ๐.
You should provide some examples, this is all a bit vague and fuzzy ...
Where I agree is that we shouldn't dumb things down to the extreme, by leaving half the features of our programming languages unused ...
Where I don't agree is that we we should strive to inject as many obscure features into our code as we can, just to make it more "terse", or to prevent our senior devs/rock stars/ninjas/code magicians from "getting bored" ...
Readability and maintainability should be number 1 - ALWAYS.
Whether you call that "clean code" or not doesn't really interest me.
So, do I agree with the jest of what you're saying here? I don't know ... I'm not sure ... and that's the "problem" I have with this article ;)
"The code should be understandable by the most junior dev in the team"
Those who preach simplicity at all costs sometimes consider what you describe as pure elitism, while it is not the case.
You can cut "junior" and the same statement may look way less ridiculous if you consider "ninja" hacks, over complicated loops and other fancies that do not bring much more value or better performance.
It's quite the same with too much abstraction that ends up in a dead-end, and you have to rewrite pretty much everything six months later, which always makes me laugh as long as I don't have to dive into it ๐คฃ.
Don't get me wrong with this comment. Complexity is part of the job and the joy ^^. I agree with most of your points but I just find complexity is quite often used inappropriately.
Totally agree...
Everyone in this job should aim to become capable of building their own wheel(s).
Really liked the lego comparison๐
Since Lego moved to selling specifics rather than generics, they have become one of the most successful companies in their market; I thing that is relevant plays against your proposal; namely teaching Why without any/enough How is not going to make any money. Business today and the need for code to be written means we don't have the time to wax-on ,wax-off learn the fundamentals; we just need to get something working. Not saying it is right or good it's just reality
Ever heard of startups havocing due to technical debt they cant make the time to fix? Been in a few ๐ most people shipping shit are consultants or bureau devs, most people discussing performance work in hardware and most people preaching style work in open source or with licensed long maintenance/evergreen software.
These perspectives are worth considering when entering a thread like this.
It is much like discussion workout routines with a sportsman, a strength athlete, a bodybuilder and a gymnast ๐
Reminds me a lot of the "A rant on change" article I wrote a while ago.
Although part of me wants to be careful about labelling anything new as inferior to the way we used to do thingsโข, but at the same time, I see enough evidence that this is really hurting the software world that I'm inclined to think this isn't just me being a grumpy old dev (I'm not even really old tbh) and more just an actual problem that should be fixed somehow.