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

  • BatmanAoD
    link
    fedilink
    arrow-up
    6
    arrow-down
    2
    ·
    3 months ago

    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
      link
      fedilink
      arrow-up
      3
      arrow-down
      2
      ·
      3 months ago

      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.

      • BatmanAoD
        link
        fedilink
        arrow-up
        3
        ·
        3 months ago

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

        • dandi8@fedia.io
          link
          fedilink
          arrow-up
          2
          ·
          3 months ago

          I do, and whether I have a good time depends on whether they have written their code well, of which the book’s suggestions are only one metric.

          • BatmanAoD
            link
            fedilink
            arrow-up
            1
            ·
            3 months ago

            I hear you, but here’s my experience:

            I’ve had one coworker whose personal coding style actually somewhat resembled that in the Clean Code examples. He wrote functions as small as possible, used many layers of abstraction, and named everything very verbosely and explicitly.

            Now, to be fair, I don’t think he did that because of Clean Code, and he also didn’t follow most of the good practices that Martin recommends. Most egregiously, he almost never tested things, even manually (!!). He once worked an entire weekend to finish something that I needed for my part of the project, and when he was done, it didn’t work, because he hadn’t actually run it at any point (!!!).

            But even when his software did work, it was horrendous to navigate and modify, specifically because of that style of writing code. I know, because when he retired, I was the only person on the team who could deal with it, so his part of the project fell entirely on me.

            Now, I’ve also had to work with code that had the opposite problem: short names, no abstraction. And a sort of “worst of both” codebase where the functions were exceedingly long and full of near-duplicate functionality, but overall there was a fair amount of modularity and abstraction.

            But in my opinion, it was much harder to deal with the code that hid all of its weirdness behind layers and layers of abstractions, despite those abstractions being carefully documented and explicitly named.