• Alien Nathan Edward@lemm.ee
    link
    fedilink
    arrow-up
    1
    ·
    edit-2
    1 year ago

    this function returns -2 as success and -1 as error

    Thats exactly the kind of thing I'm talking about when I say to prioritize refactoring over comments. If you own the system returning the error code, drag it out of the 1970s and have it return an error object with some actual information in it instead. If you don't own the system, wrap the error code in an enum that adds syntactic meaning or do a map of integer and exception and then return the mapped exception. The very last resort, after you've tried everything else, should be

    return -1; //-1 indicates success

    • SocialMediaRefugee@lemmy.ml
      link
      fedilink
      arrow-up
      1
      ·
      1 year ago

      I've worked on satellite command and control software that is literally using a 1970s OS. The code is limited for historical reasons and you have to work with the structure you are given.

      • Alien Nathan Edward@lemm.ee
        link
        fedilink
        arrow-up
        1
        ·
        1 year ago

        okay. doesn't mean you still shouldn't refactor or add a layer of abstraction where you can. we're looking for a generalizable principle here and generalizable principles don't assume that you're working with satellites that are older than the dev.