• Maalus@lemmy.world
    link
    fedilink
    arrow-up
    22
    arrow-down
    16
    ·
    4 months ago

    How bad programmers comment their code. Good programmers don’t comment at all and let the code speak for itself, leaving commenting to some obscure and arcane implementation the coder left in after a week long binge on caffeine and gummy bears.

      • Maalus@lemmy.world
        link
        fedilink
        arrow-up
        2
        arrow-down
        1
        ·
        4 months ago

        Nah. It should be obvious by just looking at it in code. If it isn’t, you haven’t extracted single purpose methods out of it yet.

        • magic_lobster_party@kbin.run
          link
          fedilink
          arrow-up
          2
          ·
          edit-2
          4 months ago

          Just having clear and concise variable names often goes a long way. Avoid using abbreviations.

          Breaking out the code into functions helps limit the number of variables within a scope, which makes it easier to name them.

    • BombOmOm@lemmy.world
      link
      fedilink
      English
      arrow-up
      11
      ·
      edit-2
      4 months ago

      Code should absolutely speak for itself. But the occasional comment is still good to explain the ‘why’ of the code when the why isn’t very obvious, often due to a niche requirement. Also any time you have to break out a hack, that needs comments up the ass, what was the bug, what URL did you find the fix at, why does this hack work, etc etc. It’s very satisfying to go back and remove those hacks after they are no longer needed, often because the underlying technology fixed the bug that had to be hacked around.

      • NotMyOldRedditName@lemmy.world
        link
        fedilink
        arrow-up
        3
        arrow-down
        1
        ·
        edit-2
        4 months ago

        It definitely feels great when I get to remove the

        //hack abc due to bug in library xyz version 1.4.5, issue tracker says it’s fixed in 1.5.0. - link

    • magic_lobster_party@kbin.run
      link
      fedilink
      arrow-up
      8
      arrow-down
      2
      ·
      edit-2
      4 months ago

      This is the truth. In my experience, the people who often writes comments are also writing the most incomprehensible code.

      Comments are frequently getting outdated as well, so they’re not in great help understanding the code either.

      • Codex@lemmy.world
        link
        fedilink
        arrow-up
        4
        ·
        4 months ago

        I was rewriting some old code of mine and ended up stripping out the comments. I kept reading them instead of the code, which I had been changing, and they were irrelevant. (I added new comments back in, though a big reason to rewrite was to make the code more self-explanatory.)