Comment from my group project teammate. You don’t need to comment every line lol

  • u/lukmly013 💾 (lemmy.sdf.org)
    link
    English
    151 month ago

    I am not a programmer, I just barely wrote one bash script in the past. But I’d say more comments are better than too few.

    When I later wanted to edit it, I got completely lost. I wrote it with absolutely no comments.

    • @riodoro1@lemmy.world
      link
      fedilink
      221 month ago

      Bash is a shit „language” and everytime i need to write the simplest thing in it I forget which variable expansion I should use and how many spaces are the right amount of spaces. It’s impossible to write nice to read bash, but even in C you can write code that comments itself.

    • @floofloof@lemmy.ca
      link
      fedilink
      English
      31 month ago

      I’ve been programming for almost 25 years and I’d still rather see too many comments than too few. A dogmatic obsession with avoiding comments screams “noob” just as much as crummy “add 1 to x” comments. If something is complex or non-obvious I want a note explaining why it’s there and what it’s supposed to do. This can make all the difference when you’re reviewing code that doesn’t actually do what the comment says it should.

    • @Fades@lemmy.world
      link
      fedilink
      1
      edit-2
      1 month ago

      Wrong. Too many comments makes the code messy and less readable and also it provides ZERO value. Just look at the post, WHAT is useful about ANY of that comment???

      All it is is a waste of goddamn space, literal junk crowding the actual code.

      I love how you admit you aren’t a developer but feel quite confident to tell us that a larger number of comments automatically means it’s better.

      This person articulated it better than I: https://midwest.social/comment/10319821

      • @LwL@lemmy.world
        link
        fedilink
        31 month ago

        Too many is still better than too few, and it’s not close. Useless comments make parsing a bit harder. Missing comments can mean hours of research.

        • @sping
          link
          English
          4
          edit-2
          1 month ago

          These are arguments talking past each other. Sure 1 useful comment and 9 redundant ones can be better than zero, but comments are not reliable and often get overlooked in code changes and become misleading, sometimes critically misleading. So often the choice is between not enough comments versus many comments that you cannot trust and will sometimes tell you flat-out lies and overall just add to the difficulty of reading the code.

          There’s no virtue in the number of comments, high or low. The virtue is in the presence of quality comments. If we try to argue about how many there should be we can talk past each other forever.

    • @01101000_01101001@mander.xyz
      link
      fedilink
      1
      edit-2
      1 month ago

      While this is true, an alternative is to name your variables and functions descriptively so that when you see number_of_cats you know that variable is the number of cats, and buyAnotherCat() is a function that increases the number of cats.