• magic_lobster_party
    cake
    link
    fedilink
    11
    edit-2
    2 years ago

    I’ve seen code that look like this:

    int delay = 15 * 60; // 10 minutes

    Even if the comment was on the same line someone forgot to update it. People just ignore comments.

    Better solution is to write (in C#):

    TimeSpan delay = TimeSpan.FromMinutes(15)

    Much more obvious what the code actually means.

      • magic_lobster_party
        cake
        link
        fedilink
        12 years ago

        It’s probably a little bit slower, but there are other things more worth to optimize than to shave off a few microseconds from a 15 minute delay.

          • magic_lobster_party
            cake
            link
            fedilink
            22 years ago

            If you’re working in embedded I guess you can probably make an inline function or a macro so it’s taken care of at compile time.

    • @18107@aussie.zone
      link
      fedilink
      72 years ago

      A better comment would be delay in seconds as that is the one thing not obvious from glancing at the code.

      • magic_lobster_party
        cake
        link
        fedilink
        132 years ago

        Or just name the variable delaySeconds if you really want to store it as an int. Bonus is that every use of the variable perfectly communicates what it is.