• @[email protected]
    link
    fedilink
    English
    73 days 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.

      • @[email protected]
        link
        fedilink
        23 days 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.

        • @[email protected]
          link
          fedilink
          -13 days 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.

    • @[email protected]
      link
      fedilink
      12 days 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.