• ruekk@lemm.ee
    link
    fedilink
    English
    arrow-up
    9
    arrow-down
    2
    ·
    15 hours ago

    Self documenting code is a myth as what’s self documenting to one person is not to the next. Code comments and process/workflow documentation is needed for a healthy codebase.

    • jimmux@programming.dev
      link
      fedilink
      arrow-up
      1
      ·
      8 hours ago

      I thought the same, until I spent a few years on a codebase where self-documenting code was enforced with detailed code reviews. That does a very good job of clearing up the ambiguity.

      If you can’t get that kind of review, then by all means use comments.

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

          Not really an opinion when most companies run on self documenting code since time immemorial.

      • zalgotext@sh.itjust.works
        link
        fedilink
        arrow-up
        2
        arrow-down
        1
        ·
        14 hours ago

        Try handing over your “self documenting code” to a junior dev who doesn’t know the language it’s written in and see how far they get with it.

        Now hand that exact same codebase with comments to the same junior dev, and I guarantee you they’ll get further than without the comments.

        • Maalus@lemmy.world
          link
          fedilink
          arrow-up
          2
          arrow-down
          3
          ·
          14 hours ago

          I have given well documented code to plenty of juniors, it comes with being a senior dev / techlead. And it was perfectly understood. Maybe you simply don’t write self documenting code.