• kautau@lemmy.world
    link
    fedilink
    arrow-up
    19
    arrow-down
    1
    ·
    1 month ago

    As long as “cleaner than you found it” also includes “better documented.” I’ve worked with people who think that “the code should speak for itself” to the point that they will make biased decisions with no explanation or documentation and then if you ask them about it after their response is “look at the PR for how that decision was made.” I’m not going to git blame and find your PR to find an outcome from an argument between two people that after scrolling just says “sometimes the API returns a JSON string here instead of nested JSON so we have this conditional” when that could be a comment

    • pastermil@sh.itjust.works
      link
      fedilink
      arrow-up
      9
      ·
      1 month ago

      Not to mention that sometimes, the code that’s supposed to “speak for itself” doesn’t do the things that they think it would do.

      • kautau@lemmy.world
        link
        fedilink
        arrow-up
        6
        ·
        1 month ago

        Right. Given the option I will always choose to work with a decent programmer who can communicate well and documents their code, over a very strong programmer that doesn’t think they should waste time with documentation

    • tyo_ukko@sopuli.xyzOP
      link
      fedilink
      arrow-up
      5
      ·
      edit-2
      1 month ago

      In particular business logic that’s not obvious should be documented in comments.

      // Typically 1 = 1, but on March accounting wants that 1 = 2. This function makes that mapping.