• AdmiralShat@programming.dev
    link
    fedilink
    English
    arrow-up
    90
    arrow-down
    3
    ·
    edit-2
    2 years ago

    If you don’t add comments, even rudimentary ones, or you don’t use a naming convention that accurately describes the variables or the functions, you’re a bad programmer. It doesn’t matter if you know what it does now, just wait until you need to know what it does in 6 months and you have to stop what you’re doing an decipher it.

    • A_Porcupine@lemmy.world
      link
      fedilink
      arrow-up
      33
      arrow-down
      1
      ·
      2 years ago

      However, engineers who rely solely on comments to explain their code, are bad at writing readable code.

    • fkn@lemmy.world
      link
      fedilink
      arrow-up
      6
      arrow-down
      1
      ·
      2 years ago

      Self documenting code is infinitely more valuable than comments because then code spreads with it’s use, whereas the comments stay behind.

      I got roasted at my company when I first joined because my naming conventions are a little extra. That lasted for about 2 months before people started to see the difference in legibility as the code started to change.

      One of the things I tell my juniors is, “this isn’t the 80s. There isn’t an 80 character line limit. The computer doesn’t benefit from your short variable names. I should be able to read most lines of code as a single non-compound sentence in English with only minor tweaks and the English sentence should be what is happening in most of those lines of code.”

      • tatterdemalion@programming.dev
        link
        fedilink
        arrow-up
        2
        ·
        edit-2
        2 years ago

        80 character limit is helpful though when you need to have many files open at a time. Maybe 100 is more reasonable. Fighting indentation is important too.

        • fkn@lemmy.world
          link
          fedilink
          arrow-up
          2
          arrow-down
          1
          ·
          2 years ago

          I, too, remember the days before ultra high definition ultra wide monitors.

          I thought this argument was bogus in the 90s on a 21" CRT and the argument has gotten even less valid since then. There are so many solutions to these problems that increase productivity for paltry sums of money it’s insane to me that companies don’t immediately purchase these for all developers.

          • tatterdemalion@programming.dev
            link
            fedilink
            arrow-up
            2
            ·
            2 years ago

            You have a point, devs should be using multiple large monitors. I will often need to have 3-4 files open at once, plus some browser windows. Having some limit on line length helps with this and for fighting code complexity.

            • fkn@lemmy.world
              link
              fedilink
              arrow-up
              1
              ·
              2 years ago

              The most important thing is comprehension. If something is too long and the length makes it less readable then it is too long.

              But if having 3-4 files open at the same time makes it harder for you to comprehend a single file because you can’t get the full picture, that’s on you.

          • icesentry@lemmy.ca
            link
            fedilink
            arrow-up
            1
            ·
            edit-2
            2 years ago

            I have a massive ultrawide and I still 100% believe in line limits. Long lines are harder to read in general but even with a limit of 100 I frequently have 3 files opened next to each other and I can’t read entire lines easily. Line limits just aren’t about the size of the monitor and I can’t believe people still say that.

            • fkn@lemmy.world
              link
              fedilink
              arrow-up
              1
              ·
              2 years ago

              I understand the concern, but readability and comprehension are way more important than line length. If the length impairs readability, it’s too long. Explicitly limits are terrible. Guidelines, fine.

              Ultimately, you do you. I still think your crazy and I think your argument is poor.

              • icesentry@lemmy.ca
                link
                fedilink
                arrow-up
                1
                ·
                2 years ago

                Yes a strict 80 character limit would be bad but that’s why modern formatters aren’t strict and default to 90-100.

                I’ve pretty much never seen code that would have been more readable had the lines been longer than that.

                My main argument is still that shorter lines are more readable. I just think it’s a bullshit argument to say that long lines are fine because large monitors exists. I don’t see how that makes me crazy.

      • MajorHavoc@lemmy.world
        link
        fedilink
        arrow-up
        1
        ·
        2 years ago

        There’s no such thing as self documenting code, unless every method and variable name has the word “because” in it.

        Anyone can read what the code does. The comments are there to answer why it does what it does the way it does.

        Why is invariably lost to time, if it’s not committed to a comment here and there.

    • tatterdemalion@programming.dev
      link
      fedilink
      arrow-up
      2
      ·
      edit-2
      2 years ago

      This is why code review exists. Writer’s can’t always see what’s wrong with their work, because they have the bias of knowing what was intended. You need a reader to see it with fresh eyes and tell you what parts are confusing.

      That’s not to say you shouldn’t try to make it readable in the first place. But reviewing and reading other people’s code is how you get better.

    • rolaulten@startrek.website
      link
      fedilink
      arrow-up
      1
      ·
      2 years ago

      Let’s take this one step further. I should be able to get the core ideas in your code by comments and cs 101 level coding (eg basic data structures, loops, and if/then).