this post was submitted on 10 Aug 2024
0 points (NaN% liked)

Programming

17364 readers
436 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 !webdev@programming.dev



founded 1 year ago
MODERATORS
 

Seeing that Uncle Bob is making a new version of Clean Code I decided to try and find this article about the original.

top 11 comments
sorted by: hot top controversial new old
[–] thesmokingman@programming.dev 1 points 3 months ago

I feel like it’s wrong to idolize anything in the same way that it’s wrong to throw out many things (there are some clear exceptions usually in the realm of intolerance but that’s unrelated to this). Clean Code, like every other pattern in software development, has some good things and some bad things. As introduction to the uninitiated, it has many good things that can be built on later. But, like Gang of Four, it is not the only pattern we apply in our craft and, like Agile, blind devotion, turning a pattern into a prescription, to Clean Code is going to lead to a lot of shit code.

Cognitive load helps us understand this problem a lot better. As a junior with no clue how to write production code, is Clean Code going to provide with a decent framework I can quickly learn to start learning my craft, should I throw it out completely because parts are bad, or should I read both Clean Code and all its criticism before I write a single line? The latter two options increase a junior’s extraneous cognitive load, further reducing the already slim amount of power they can devote to germane cognitive load because their levels of intrinsic are very high by the definition of being a junior.

Put a little bit differently, perfection (alternatively scalable, maintainable, shipped code) comes from learning a lot of flawed things and adapting those patterns to meet the needs. I am going to give my juniors flawed resources to learn from to then pick and choose when I improve those flaws. A junior has to understand the limitations of Clean Code and its failures to really understand why the author is correct here. That’s more cognitive science; we learn best when we are forming new connections with information we already know (eg failing regularly). We learn worse when someone just shows us something and we follow it blindly (having someone solve your problem instead of failing the problem a few times before getting help).

I’m gonna be super hand-wavy with citations here because this a soapbox for me. The Programmer’s Brain by Felienne Hermans does a good job of pulling together lots of relevant work (part 2 IIRC). I was first introduced to cognitive load with Team Topologies and have since gone off reading of bunch of different things in pedagogy and learning theory.

[–] dandi8@fedia.io 0 points 3 months ago (2 children)

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.

public void calculateCommissions() {
  calculateDefaultCommissions();
  if(hasExtraCommissions()) {
    calculateExtraCommissions();
  } 
} 

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...

[–] realharo@lemm.ee 0 points 3 months ago* (last edited 3 months ago) (1 children)

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.

[–] dandi8@fedia.io 0 points 3 months ago

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).

[–] dgriffith@aussie.zone 0 points 3 months ago* (last edited 3 months ago) (1 children)

in which case I will go one level down, to the calculateExtraCommissions() method.

In which case you will discover that the calculateExtraCommissions() function also has the same nested functions and you eventually find six subfunctions that each calculate some fraction of the extra commission, all of which could have been condensed into three lines of code in the parent function.

Following the author's idea of clean code to the letter results in a thick and incomprehensible function soup.

[–] dandi8@fedia.io 0 points 3 months ago (1 children)

It's only as incomprehensible as you make it.

If there are 6 subfunctions, that means there's 6 levels of abstraction (assuming the method extraction was not done blindly), which further suggests that maybe they should actually be part of a different class (or classes). Why would you be interested in 6 levels of abstraction at once?

But we're arguing hypotheticals here. Of course you can make the method implementations a complete mess, the book cannot guarantee that the person applying the principles used their brain, as well.

[–] BatmanAoD@programming.dev 0 points 2 months ago (1 children)

Because abstractions leak. Heck, abstractions are practically lies most of the time.

What's the most time-consuming thing in programming? Writing new features? No, that's easy. It's figuring out where a bug is in existing code.

How do abstractions help with that? Can you tell, from the symptoms, which "level of abstraction" contains the bug? Or do you need to read through all six (or however many) "levels", across multiple modules and functions, to find the error? Far more commonly, it's the latter.

And, arguably worse, program misbehavior is often due to unexpected interactions between components that appear to work in isolation. This means that there isn't a single "level of abstraction" at which the bug manifests, and also that no amount of unit testing would have prevented the bug.

[–] dandi8@fedia.io 0 points 2 months ago (2 children)

How do abstractions help with that? Can you tell, from the symptoms, which "level of abstraction" contains the bug? Or do you need to read through all six (or however many) "levels", across multiple modules and functions, to find the error?

I usually start from the lowest abstraction, where the stack trace points me and don't need to look at the rest, because my code is written well.

[–] FlorianSimon@sh.itjust.works 1 points 2 months ago

Yeah, cause silly mistakes in one place never affect another place that's completely unrelated.

[–] BatmanAoD@programming.dev 0 points 2 months ago

That's great, but surely, from time to time, you have to deal with code that other people have written?

[–] kogasa@programming.dev -1 points 2 months ago

No, it isn't