this post was submitted on 10 Aug 2024
138 points (95.4% liked)

Programming

17443 readers
252 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.

you are viewing a single comment's thread
view the rest of the comments
[–] dandi8@fedia.io -4 points 3 months ago* (last edited 3 months ago) (46 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...

[–] Kache@lemm.ee 18 points 3 months ago* (last edited 3 months ago) (9 children)

I really dislike code like that. Code like that tends to lie about what it says it does and have non-explicit interactions/dependencies.

The only thing I can really be certain from that is:

  doAnything();
  if(doAnything2()) {
    doAnything3();
  }

I.e. almost nothing at all because the abstractions aren't useful.

[–] kogasa@programming.dev 3 points 3 months ago (8 children)

You realize this is just an argument against methods?

[–] Kache@lemm.ee 10 points 3 months ago (1 children)

All methods? Of course not. Just methods like these.

[–] kogasa@programming.dev 2 points 3 months ago (1 children)

No, your argument is equally applicable to all methods. The idea that a method hides implementation details is not a real criticism, it's just a basic fact.

[–] magic_lobster_party@kbin.run 9 points 3 months ago (1 children)

These kind methods hide too much.

Where can I find the commissions these methods calculated? Does extra commissions depend on the calculations of default commissions? Do I need to calculate default commissions before calling hasExtraCommisions? What happens if I calculate extra commissions if hasExtraCommisions return false?

There are so many questions about this code that should be immediately obvious, but isn’t.

[–] kogasa@programming.dev 1 points 3 months ago (1 children)

What you're saying is "descriptive method names aren't a substitute for knowing how the code works." That's once again just a basic fact. It's not "hiding," it's "organization." Organization makes it easier to take a high level view of the code, it doesn't preclude you from digging in at a lower level.

[–] magic_lobster_party@kbin.run 5 points 3 months ago (2 children)

What I’m saying is that it’s hiding too much of the control flow.

Compare it with this code:

public double calculateCommision(Sale sale, Contract contract) {
    double defaultCommision = calculateDefaultCommision(sale);
    double extraCommision = calculateExtraCommision(sale, contract);
    return defaultCommision + extraCommision;
}

This is about the same number of lines, but it communicates so much more about the control flow. It gives us an idea which data is involved in the calculations, and where we can find the result of all the calculations. We can make assumptions that the functions inside are independent from each other, and that they’re probably not relying on side effects.

This is also against clean code examples, because Uncle Bob seems to be allergic against function arguments and return values.

[–] djnattyp@lemmy.world 1 points 3 months ago

This is also against clean code examples, because Uncle Bob seems to be allergic against function arguments and return values.

I think this is your strawman version of "Clean Code"... not anything that's actually in it...

I "like" some parts of your example more than the previous one, but a lot of this depends on where exactly in the whole program this method is - if this method is on a "Salesman" class - does it make sense to pass the "Contract" in? If there's a Contract class available, why doesn't the "calculateCommission" method exist on it?

[–] kogasa@programming.dev 0 points 3 months ago (1 children)

You're making assumptions about the control flow in a hypothetical piece of code...

[–] azulavoir@sh.itjust.works 1 points 3 months ago

Yes, because that's exactly what the thread is about. Making assumptions about control flow.

load more comments (6 replies)
load more comments (6 replies)
load more comments (42 replies)