• haruki@programming.dev
    link
    fedilink
    arrow-up
    2
    ·
    1 year ago

    “Code is the documentation” is the paradise we all want to be someday. But some people use that as an excuse to not write the documentation explaining why this piece of code exists in the first place. I find it extremely annoying when there is not a single architecture diagram is available and someone tell me to figure it out by reading his/her spaghetti code.

    • Von_Broheim@programming.dev
      link
      fedilink
      arrow-up
      2
      ·
      1 year ago

      The problem is that code is language and people who write shit code tend to write shit comments, so no value is gained anyway. The sort of person who’d write good comments will most likely write good code where these comments are not needed, and when they intentionally write shit code they’d probably explain why.

      So best you can hope for is that both of these people write comments about why they decided to write a comment, and hopefully the person who writes shit code improves over time.