• @RalphWolf@lemmy.ca
    link
    fedilink
    English
    228 months ago

    Document your code like the guy who will be maintaining it is Dexter, and he knows where you live.

    • @Aurenkin@sh.itjust.works
      link
      fedilink
      17
      edit-2
      8 months ago
      // This function calculates applicable discounts given a customer's loyalty status
      // STOP BEFORE SEASON 8 DEXTER PLEASE 
      fun calculateDiscountRate(loyalty: LoyaltyStatus): Set {
          // No seriously you can hide out at my place if you need to just please don't let them do it 
      ...
      
      • Anna
        link
        fedilink
        28 months ago

        And don’t watch that new dexter spin off

  • HubertManne
    link
    fedilink
    68 months ago

    I get this one so much. I don’t consider myself a developer because I tend to just touch code but that means I won’t touch any for weeks. Worse I tend to do a lot of poc or boot strapping type of things and so its like there was a user story last pi to check the feasibility of something and now have a user story to get it regularly working in a poc env and I have forgotten everything about that particular system or language or whatever.

    • @pfm@scribe.disroot.org
      link
      fedilink
      18 months ago

      That’s why we keep notes… Literate DevOps is a solution for my preferred editor, but there definitely are solutions for other tools too, even if they don’t work exactly the same.

      I can’t recommend keeping notes too much.

      • HubertManne
        link
        fedilink
        28 months ago

        I mean thats great but finding the notes is always a chore to because so much has been done between now and then and there are a lot of stuff done with their own notes. We are actually required to document in like 3 different ways although we don’t need to do all 3 all the time. informal, formal internal, formal customer.

        • @pfm@scribe.disroot.org
          link
          fedilink
          28 months ago

          I’m not going to argue, because I don’t know your work environment, but the notes I mentioned weren’t supposed to be published or attached to the product. They’re more of a personal knowledge base, where you can look up former approaches, issues found in the past, reasoning, decisions with context… All the zettelkasten tools out there do exactly that: help maintaining a useful knowledge base.

    • qprimed
      link
      fedilink
      English
      16 months ago

      this resonates so much…

      “ok, which one of you crackheads decided an unconstrained recursive C function was a good idea right her… oh.”

  • @biggerbogboy@sh.itjust.works
    link
    fedilink
    38 months ago

    this was me while writing my website for my screen and media course, I come back a week later and try to interpret these ancient runes inscribed on my IDE, had to stare at it for like half an hour to finally get what I made.