this post was submitted on 10 Aug 2024
145 points (95.0% liked)
Programming
17429 readers
218 users here now
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Rules
- Follow the programming.dev instance rules
- Keep content related to programming in some way
- If you're posting long videos try to add in some form of tldr for those who don't want to watch videos
Wormhole
Follow the wormhole through a path of communities [email protected]
founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
It makes me sad to see people upvote this.
Robert Martin's "Clean Code" is an incredibly useful book which helps write code that Fits In Your Head, and, so far, is the closest to making your code look like instructions for an AI instead of random incantations directed at an elder being.
The principle that the author of this article argues against seems to be the very principle which helps abstract away the logic which is not necessary to understand the method.
Tells me all I need to know about what the method does - it calculates default commissions, and, if there are extra commissions, it calculates those, too. It doesn't matter if there's 30 private methods inside the class because I don't read the whole class top to bottom.
Instead, I may be interested in how exactly the extra commissions are calculated, in which case I will go one level down, to the
calculateExtraCommissions()
method.From a decade of experience I can say that applying clean code principles results in code which is easier to work with and more robust.
Edit:
To be clear, I am not condoning the use of global state that is present in some examples in the book, or even speaking of the objective quality of some of the examples. However, the author of the article is throwing a very valuable baby with the bathwater, as the actual advice given in the book is great.
I suppose that is par for the course, though, as the aforementioned author seems to disagree with the usefulness of TDD, claiming it's not always possible...
Why is it a
void
method? This only tells me that some state is mutated somewhere, but the effect is neither visible nor documented.I would expect a function called "calculate" to just return a number and not have any side effects.
You're nitpicking.
As it happens, it's just an example to illustrate specifically the "extract to method" issues the author had.
Of course, in a real world scenario we want to limit mutating state, so it's likely this method would return a
Commission
list, which would then be used by a Use Case class which persists it.I'm fairly sure the advice about limiting mutating state is also in the book, though.
At the same time, you're likely going to have a void somewhere, because some use cases are only about mutatimg something (e.g. changing something in the database).
It's not nitpicking, stuff like this is far more impactful than choosing between 5 lines vs 10 lines long methods, or whether the
hasExtraCommissions
"if
" belongs inside or outside ofcalculateExtraCommissions
. This kind of thing should immediately jump out at you as a red flag when you're reading code, it's not something to handwave away as a detail.I never claimed it's not important, I'm just saying it's not relevant here, as there is no context to where this method was put in the code.
As I said, it might be top-level. You have to mutate state somewhere, because that's what applications ultimately do. You just don't want state mutations everywhere, because that makes bad code.
The whole book is like this, though, and these are specifically supposed to be examples of "good" code. The rewritten time class toward the end, a fully rewritten Java module, is a nightmare by the time Martin finishes with it. And I'm pretty sure it has a bug, though I couldn't be bothered to type the whole thing into an editor to test it myself.