• conciselyverbose@sh.itjust.works
    link
    fedilink
    arrow-up
    130
    ·
    4 months ago

    That’s basically what comments are most useful for. When you’re doing something that’s not obvious, and want to make sure the “why” doesn’t get lost to time.

    • ChickenLadyLovesLife@lemmy.world
      link
      fedilink
      English
      arrow-up
      13
      ·
      4 months ago

      I spent a year making my company’s iOS apps accessible (meaning usable for the blind and people with vision disabilities). I had to do a lot of weird shit either because of bugs in Apple’s VoiceOver technology or because of the strange way in which our code base was broken up into modules (some of which I did not have access to) and I would always put in comments explaining why I was doing what I was doing. The guy doing code review and merges would always just remove my comments (without any other changes) because he felt that not only were comments unnecessary but also they were a “code smell” indicating professional incompetence. I feel sorry for whoever had to deal with that stuff at a later point.

      • lad@programming.dev
        link
        fedilink
        English
        arrow-up
        2
        ·
        4 months ago

        Well, this is shitty

        I hope the reviewer did not also squash commits, and the next programmer would be able to at least dig what was there.

        Doing changes after some rockstar dev implemented some really complex service, but left no clues as to what does what is so frustrating, and I can never be sure that I don’t break anything in a different place completely

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

          I meant to say commits and not merges, and yes he removed the comments before committing. It made no difference in long run because every new release broke all the accessibility stuff anyway. It’s amazing how little developers can be made to care about blind people - almost as little as managers. The only reason my company cared at all was they were facing million-dollar-a-month fines from the FCC.