• magic_lobster_party
    link
    fedilink
    12
    edit-2
    1 year 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.

    • @[email protected]
      link
      fedilink
      81 year 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
        link
        fedilink
        131 year 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.