• Bappity@lemmy.world
    link
    fedilink
    English
    arrow-up
    54
    ·
    edit-2
    1 year ago

    me when first starting out at a job commenting everything I can
    VS
    me a couple years in completely lost because I never updated the comments and now none of them make any sense whatsoever

    • xmunk@sh.itjust.works
      link
      fedilink
      arrow-up
      60
      ·
      1 year ago

      Commenting well is a highly advanced skill. I generally prefer no comments on code since it’s less likely to confuse people and I’ll merrily purge auto-doc comments and anything like

      // getId() returns an id

      That comment has negative value.

      • kubica@kbin.social
        link
        fedilink
        arrow-up
        24
        ·
        1 year ago

        I can’t help it, I always get the mental image of hands clapping sarcastically when I see something like that.

      • Platypus@sh.itjust.works
        link
        fedilink
        English
        arrow-up
        10
        ·
        1 year ago

        In my experience refactoring lots and lots of crappy code left by devs long gone, a dev who can write useful comments is by and large a dev who can write code clean and simple enough not to need them. If the code doesn’t have informative names and clear separation of concern, chances are a comment won’t help because the dev didn’t really know what they did that worked in the first place.

        • MagicShel@programming.dev
          link
          fedilink
          arrow-up
          14
          ·
          1 year ago

          Generally, yes. However I have been known to document exactly why I’m doing something incredibly stupid - because it’s required but a stupid third party library which, despite being awful, is still better than implementing it myself as a refactor.

        • Bappity@lemmy.world
          link
          fedilink
          English
          arrow-up
          3
          ·
          1 year ago

          a dev who can write useful comments is by and large a dev who can write code clean and simple enough not to need them.

          my boss is great in this regard and also always has to keep reminding us to write unit tests 😅

        • xmunk@sh.itjust.works
          link
          fedilink
          arrow-up
          18
          ·
          1 year ago

          The best explanation I’ve ever heard is:

          Comments should state the ‘Why’ never the ‘What’.

          • hikaru755@feddit.de
            link
            fedilink
            arrow-up
            1
            ·
            1 year ago

            There are some cases though where the code is just complicated for reasons outside of your control, in which case “what” comments are good - but they should never be taken at face value, but only used as a first step in understanding the code. There’s a significant risk of the code not actually doing what the comment says.

        • dukk@programming.dev
          link
          fedilink
          arrow-up
          3
          ·
          1 year ago

          Yeah. Most of the time I use comments in my algorithms, as they often use some weird optimized black magic which are difficult to understand without comments.

      • Solar Bear@slrpnk.net
        link
        fedilink
        English
        arrow-up
        6
        ·
        1 year ago

        I write a lot of fairly simple scripts in Bash and PowerShell that should be easily understood by anybody else with moderate experience in the language, but I leave a lot of obvious comments because my coworkers don’t write any code and are extremely skittish about my automations. I add them basically to quell their fears.

          • Solar Bear@slrpnk.net
            link
            fedilink
            English
            arrow-up
            7
            ·
            edit-2
            1 year ago

            These are scripts that manage stuff on a few hundred user endpoints and a few servers. They were doing basically everything manually until I got here, and the only way I could get them on board with my slow introduction of automation is to let them see it. I have to ensure things don’t get too long, complex, or hard to explain, or they start getting nervous.

      • oce 🐆@jlai.lu
        link
        fedilink
        arrow-up
        4
        ·
        1 year ago

        I’d rather teach people to comment well through my reviews. Much easier to understand two lines of well written function description in English than 20 lines of code.