• brokenlcd@feddit.it
    link
    fedilink
    arrow-up
    1
    ·
    9 months ago

    Tbf, i always comment my code to do a sanity check of what i am doing along the way( think rubber duck method with comments). The problem is that my writing is so cryptic i am the only one that could ever understand it.

    • spooky2092@lemmy.blahaj.zone
      link
      fedilink
      English
      arrow-up
      0
      ·
      9 months ago

      I have to comment my code because otherwise I have no idea wth I was writing 6mo ago.

      Like, I recently had to update a script I wrote 2 years ago and had thought 'this is self explanatory, I don’t need to comment it’s only to have me come back and have to walk the code to figure out I forgot to include an edge case that hadn’t occurred yet …

      • Omgpwnies@lemmy.world
        link
        fedilink
        English
        arrow-up
        0
        ·
        9 months ago

        Break it up into functions with names that describe what it does, then the script becomes basically a sequence of function calls and is easier to read and troubleshoot.

        • jkercher@programming.dev
          link
          fedilink
          English
          arrow-up
          1
          ·
          9 months ago

          I’m on your side dude. Comments rot. Some are useless. Don’t even get me started on doxygen comments.