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

  • Deebster@programming.dev
    link
    fedilink
    arrow-up
    45
    ·
    3 months ago

    I felt the same when reading that book, and I never finished it because following the rules he suggested produced horrible code.

    If memory serves, he also suggested that the ideal if statement only had one line inside, and you should move multiple lines into a function to achieve this.

    I once had to work on a codebase that seemed like it had followed his style, and it was an awful experience. There were hundreds of tiny functions (most only used once) and even with an IDE it was a chore to follow the logic. Best case the compiler removed most of this “clean” code and the runtime wasn’t spending most of its time managing the stack like a developer had to do.

    • Cratermaker@discuss.tchncs.de
      link
      fedilink
      arrow-up
      18
      ·
      3 months ago

      There’s nothing quite like the unique pain of navigating an unfamiliar codebase that treats abstraction as free and lines of code in one place as expensive. It’s like reading a book with only one sentence per page, how are you supposed to understand the full context of anything??

      • oldfart@lemm.ee
        link
        fedilink
        arrow-up
        3
        ·
        3 months ago

        Haha, the horrors of trying to fix a bug in OpenOffice flash before my eyes

  • Mikina@programming.dev
    link
    fedilink
    arrow-up
    21
    ·
    3 months ago

    There’s a piece of code in our hobby game project that I’ve written after attending classes in college about how to write clean and SOLID code. It’s the most overengineered piece of shit I’ve ever written. I’m not saying it’s the fault of the lectures, of course it’s on me being a little bit over zealous, but it does check all the boxes - It’s a simple “show selectable list of stuff”, follows MVC, it’s extensible without rewriting to adittional data-types and formats, extensible view that can show any part of data you need, generic, and in general it could be used anywhere we need, for any kind of data.

    There’s only one place where we need and use such list in our game.

    I needed to rewrite a part of it, since the UI changed drastically, to not need this kind of list, while also adding events into the process. I haven’t seen the code for almost 4 years, and it’s attrocious. Super hard to understand what’s going on, since it’s too generic, interfaces and classes all over the place, and while it probably would be possible to rewrite the views for the new features we need, it’s just so complex that I don’t have the mental capacity to again figure out how it was supposed to work and properly wire it up again.

    I’m not saying it’s fault of the classes, or SOLID. It’s entirely my fault, because the classes inspired and hyped me with ideas about what a clean code should look like, that I didn’t stop and think whether it’s really needed here, and went over-the-top and overengineered the solution. That’s what I’d say is the danger of such Clean Code books and classes - it’s easy to feel clever for making something that passes SOLID to the letter, but extensibility usually comes at a complexity, and it’s super important to stop and think - do I really need it?

  • thesmokingman@programming.dev
    link
    fedilink
    arrow-up
    25
    arrow-down
    5
    ·
    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.

    • arendjr@programming.dev
      link
      fedilink
      arrow-up
      12
      arrow-down
      6
      ·
      3 months ago

      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?

      I see what you’re getting at it, and I agree we shouldn’t increase the load for juniors upfront. But I think the point is mainly there are better resources for juniors to start with than Clean Code. So yeah, the best option is to throw it out completely and let juniors start elsewhere instead, otherwise they are starting with many bad parts they don’t yet realize are bad. That too would increase cognitive load because they would need to unlearn those lessons again.

      • JackbyDev@programming.devOP
        link
        fedilink
        English
        arrow-up
        7
        arrow-down
        6
        ·
        3 months ago

        Exactly. The article is pretty clear with this point. Junior devs aren’t the ones we should be giving mixed bags of advice to.

        • thesmokingman@programming.dev
          link
          fedilink
          arrow-up
          7
          arrow-down
          8
          ·
          3 months ago

          I’m all for it! What’s the resource that solves this problem?

          It must be perfect since we can’t ever give mixed bags of advice. There are apparently better resources although I didn’t see one in the article and things like Code Complete and Pragmatic Programmer address a lot of the same things. Hell, we probably shouldn’t talk about The Mythical Man-Month anymore either. Do we also throw out Design Patterns since singletons are arguably bad design these days?

            • thesmokingman@programming.dev
              link
              fedilink
              arrow-up
              6
              arrow-down
              7
              ·
              edit-2
              3 months ago

              I took the things defined in the comments responding to mine and extended them. If we can’t share a mixed bag, all of the things I highlighted are out. It would be logically inconsistent to think otherwise starting from your conclusions. Either we have perfect resources or we have, as I called out, to pick and choose our battles. I want to see a perfect resource not ad hominem.

              Edit: genuinely surprised to see someone on a CS instance not understand reductio ad absurdum/impossibile (depending on how you feel about Gang of Four)

                • thesmokingman@programming.dev
                  link
                  fedilink
                  arrow-up
                  4
                  arrow-down
                  9
                  ·
                  3 months ago

                  Your response was to call my argument sarcasm. That is directed at me rather than what I said. That’s quite literally, not figuratively, the definition of sarcasm.

                  I wish you the best of luck. You don’t seem to be interested in the comments unless it agrees with you and you have yet to share a perfect resource. Have fun!

  • onlinepersona@programming.dev
    link
    fedilink
    English
    arrow-up
    7
    arrow-down
    3
    ·
    3 months ago

    IMO it would be best to present code that fits in a single file to people on the net and refactor it to their liking while keeping the same functionality, then let others rate the style and pick a few characteristics. Then the code can be ranked by the different characteristics to obtain the top 5 or so “cleanest” coding styles.

    I feel it’s worth doing an entire study instead of relying on what one dude says is clean code. Let the people speak.

    Anti Commercial-AI license

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

    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…

    • Feyd@programming.dev
      link
      fedilink
      arrow-up
      29
      arrow-down
      1
      ·
      edit-2
      3 months ago

      I hate reading code like this. It means that there is a bunch of object or global state that could be getting modified by anything all over the place that I can’t see just by looking at the method. In other words, if you say you understand this method, it is because you are making assumptions about other code that might be wrong.

      I’ll take a 30 line pure function over a web of methods changing member state every time.

    • RecluseRamble@lemmy.dbzer0.com
      link
      fedilink
      arrow-up
      16
      ·
      edit-2
      3 months ago

      Tells me all I need to know about what the method does

      No, it only tells you what the method is supposed to do.

      While that may be helpful it may also be misleading. It helps just as much as comments when debugging - and that probably is the most relevant reason for trying to figure out someone else’s code.

      • nous@programming.dev
        link
        fedilink
        English
        arrow-up
        11
        ·
        edit-2
        3 months ago

        It also tells you nothing about the data flow or the data at all. What do these functions do? What data to they act on? It is all just pure side effects and they could be doing anything at all. That is far from what I consider clean.

        “Show me your flowchart and conceal your tables, and I shall continue to be mystified. Show me your tables, and I won’t usually need your flowchart; it’ll be obvious.” – Fred Brooks, The Mythical Man Month (1975)

    • realharo@lemm.ee
      link
      fedilink
      arrow-up
      15
      ·
      edit-2
      3 months ago

      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
        link
        fedilink
        arrow-up
        2
        arrow-down
        6
        ·
        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).

        • realharo@lemm.ee
          link
          fedilink
          arrow-up
          6
          ·
          edit-2
          3 months ago

          It’s not nitpicking, stuff like this is far more impactful than choosing between 5 lines vs 10 lines long methods, or whether the hasExtraCommissionsif” belongs inside or outside of calculateExtraCommissions. 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.

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

            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.

            • BatmanAoD@programming.dev
              link
              fedilink
              arrow-up
              1
              ·
              3 months ago

              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.

    • Kache@lemm.ee
      link
      fedilink
      arrow-up
      15
      arrow-down
      1
      ·
      edit-2
      3 months ago

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

            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.

    • Takumidesh@lemmy.world
      link
      fedilink
      arrow-up
      10
      arrow-down
      2
      ·
      3 months ago

      Declarative, functional code is by definition much closer to ai prompts than any imperative code. Businesses are just scared of functional programming because they think that by adopting oop then can make developers interchangeable, the reality is that encapsulation is almost never implemented in a proper way and we should be instead focusing on languages that enforce better systems over slamming oop into everything.

      Hell, almost every modern developer agrees that inheritance is just bad and many frown upon polymorphic code as well.

      So if we can’t properly encapsulate, we don’t want inheritance or polymorphism, we don’t want to modify state, what are we even doing with oop?

      • Kogasa@programming.dev
        link
        fedilink
        arrow-up
        4
        arrow-down
        1
        ·
        3 months ago

        No, not “almost every modern developer thinks inheritance is just bad.” They recognize that “prefer composition over inheritance” has merit. That doesn’t mean inheritance is itself a bad thing, just a situational one. The .NET and Java ecosystems are built out of largely object-oriented designs.

    • JackbyDev@programming.devOP
      link
      fedilink
      English
      arrow-up
      7
      ·
      3 months ago

      I can’t judge this example without seeing what would be inside those other methods. As presented, what you say makes sense, but many of the full examples shown in the article show very strange combinations.

      I agree that private methods can help make code “fit in your head” but at the same time, dogmatically pursuing this can spread code out more which does the opposite.

    • Lysergid@lemmy.ml
      link
      fedilink
      arrow-up
      9
      arrow-down
      2
      ·
      3 months ago

      Folks really trying to argue about example code. Even created “global state” straw man. Here is secret - if you are using global state then code is shit in the most cases.

    • Dave.@aussie.zone
      link
      fedilink
      arrow-up
      5
      ·
      edit-2
      3 months ago

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

        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.

        • FizzyOrange@programming.dev
          link
          fedilink
          arrow-up
          2
          ·
          3 months ago

          Why would you be interested in 6 levels of abstraction at once?

          Because there aren’t 6 interesting levels of abstraction. It’s like talking to a child:

          What are you doing?

          Finances

          What does that involve?

          Processing money.

          What kind of processing?

          Summarising

          What kind of summaries?

          Summaries of everything

          What specifically though?

          Summaries

          Ok so you’re just displaying total balance then…

        • BatmanAoD@programming.dev
          link
          fedilink
          arrow-up
          1
          ·
          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.

    • TehPers@beehaw.org
      link
      fedilink
      English
      arrow-up
      2
      ·
      3 months ago

      If those functions are huge units of work or pretty complex, I can agree. For most cases though, a simple code comment should do to explain what’s going on?

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

        Comments should never be about what is being done. They should only ever be about why it is being done.

        If you write your code like suggested in the book, you won’t need to rely on possibly outdated comments to tell you what’s going on.

        Any comment about “what is being done” can be replaced with extracting the code in question to a separate, well-named method.

        • JackbyDev@programming.devOP
          link
          fedilink
          English
          arrow-up
          6
          ·
          3 months ago

          I disagree about comments should never be about what is being done. If what is being done is not obvious then they’re important. Take assembly code as an example. Or complicated bit operations. I agree the why is more important to document than the what but saying the what is never important seems misguided.

          Also, this may be a semantics thing, but oftentimes the code’s specification is in doc comments. I don’t believe you’re claiming code shouldn’t ever have specifications, this isn’t meant as a gotcha lol.

        • lolcatnip@reddthat.com
          link
          fedilink
          English
          arrow-up
          4
          ·
          3 months ago

          A function name can be misleading just like a comment can, in the same scenarios and for the same reasons, plus it’s harder to update because you have to change it in at least two places.

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

            And yet, outdated comments are far, far more common than outdated function names.

            Also, if you’re changing a comment which explains the “what”, you should likely change the method name, as well.

            It’s important for the client to know what the method does by looking at the name, so why would you duplicate your effort?

            • lolcatnip@reddthat.com
              link
              fedilink
              English
              arrow-up
              1
              ·
              3 months ago

              And yet, outdated comments are far, far more common than outdated function names.

              Because people don’t try to squeeze a complete description of what a function does into a single identifier, which is what you you would have to do if you want function names to take the place of comments. I for one don’t want to strip all the spaces and punctuation out of my comments so I can use them as function names, and I really didn’t want to read someone else’s code written in that style.

        • TehPers@beehaw.org
          link
          fedilink
          English
          arrow-up
          5
          arrow-down
          1
          ·
          3 months ago

          I think it’s good to document why things are done, but extracting things out into another function is just documenting what is being done with extra steps. This also comes with a number of problems:

          1. Not all languages are readable. Documenting what is being done is important in some C, or when working with some libraries that have confusing usage syntax.
          2. Not all people reading the code know the language or libraries well. Those people need guidance to understand what the code is trying to do. Function names can of course do this, but…
          3. Not all types can be named in all languages. Some languages have a concept of “opaque types”, which explicitly have no name. If parameter and return types must be specified in that language, working around that restriction may result in unnecessarily complicated code.
          4. Longer files (the result of having dozens of single-use functions) are less readable. Related logic is now detached into pointers that go all over the file all because of an allergic reaction to code comments, where a simple // or # would have made the code just as readable.
          5. Function names can be just as outdated as code comments. Both require upkeep. Speaking from personal experience, I’ve seen some truly misleading/incorrect function names.