Whenever you store a value that has a unit in a variable, config option or CLI switch, include the unit in the name. So:

  • maxRequestSize => maxRequestSizeBytes
  • elapsedTime => elapsedSeconds
  • cacheSize => cacheSizeMB
  • chargingTime => chargingTimeHours
  • fileSizeLimit => fileSizeLimitGB
  • temperatureThreshold => temperatureThresholdCelsius
  • diskSpace => diskSpaceTerabytes
  • flightAltitude => flightAltitudeFeet
  • monitorRefreshRate => monitorRefreshRateHz
  • serverResponseTimeout => serverResponseTimeoutMs
  • connectionSpeed => connectionSpeedMbps

EDIT: I know it’s better to use types to represent units. Please don’t write yet another comment about it. You can find my response to that point here: https://programming.dev/comment/219329

  • Ullallulloo@civilloquy.com
    link
    fedilink
    English
    arrow-up
    10
    ·
    edit-2
    1 year ago

    Those are just types. You shouldn’t write types in the names. It’s called Hungarian Notation, but it’s just redundant. If you need to check the type of a variable, hover over it and your IDE should tell you that temperatureThreshold is type DegreesCelsius. No need to add extra cruft. There’s also a question of how specific everything needs to be.

    It’s also especially problematic if you later refactor things. If you change units, then you have to rename every variable.

    Plus, variables shouldn’t really be tied to a specific unit. If you need to display in Fahrenheit, you ideally just pass temperatureThreshold and it converts types as needed. A Temperature type that that has degreesF() and degreesC() functions is even cleaner. Units should just be private to the type’s struct.

    • 𝕊𝕚𝕤𝕪𝕡𝕙𝕖𝕒𝕟@programming.devOP
      link
      fedilink
      English
      arrow-up
      11
      arrow-down
      2
      ·
      edit-2
      1 year ago

      I absolutely agree. But:

      • sometimes you need to modify existing code and you can’t add the types necessary without a giant refactoring
      • you can’t express units with types in:
        • JSON/YAML object keys
        • XML tag or attribute names
        • environment variable names
        • CLI switch names
        • database column names
        • HTTP query parameters
        • programming languages without a strong type system

      Obviously as a Hungarian I have a soft spot for Hungarian notation :) But in these cases I think it’s warranted.

      • abhibeckert@lemmy.world
        link
        fedilink
        English
        arrow-up
        1
        ·
        1 year ago

        Not sure what languages you commonly work with, but in good modern languages you can simply declare “feet” as an alias of integer (or double?), and no refactoring would be required.

        And any good toolchain to parse / generate JSON/etc can absolutely get the types right.

    • JackbyDev@programming.dev
      link
      fedilink
      English
      arrow-up
      1
      ·
      1 year ago

      There are plenty of times where the type is just something generic like an integer and making a wrapper type is not worth the effort and this is a useful approach.

  • lavafroth@programming.dev
    link
    fedilink
    English
    arrow-up
    3
    ·
    1 year ago

    I think some of the modern languages handle this pretty well. Rust has algebraic data types thanks to its brilliant use of enums. Go has a similar type system. Taking the elapsedTime example from the post, for solving this duration related problem, a Rust programmer would use Duration::from_millis(millis) or Duration::from_secs(secs) and forget about the unit. It’s a duration, that’s what you wanna care about.

    • 𝕊𝕚𝕤𝕪𝕡𝕙𝕖𝕒𝕟@programming.devOP
      link
      fedilink
      English
      arrow-up
      7
      ·
      edit-2
      1 year ago

      Related: Making Wrong Code Look Wrong

      TL;DR: there is good and bad Hungarian notation. Encoding types (like string or int) in variable names is bad. Encoding information that cannot be expressed in the type system is good. (Though with the development of type systems, more and more of those concepts can be moved into the types, keeping variable names clean.)

      But as a Hungarian, I’m obviously a little biased :)

  • cgtjsiwy@programming.dev
    link
    fedilink
    English
    arrow-up
    2
    ·
    1 year ago

    In languages with static and convenient type systems, I try to instead encode units as types. With clever C++ templating, you can even get implicit conversions (e.g. second -> hour) and compound types (e.g. meter and second types also generate m/s, m/s^2 and so on).

    • CoderKat@kbin.social
      link
      fedilink
      arrow-up
      1
      ·
      1 year ago

      A good example is Go’s time package. You’d normally express durations like 5 * time.Second and the result is a time.Duration. Under the hood, it’s just an int64 nanoseconds, but you’d never use it as a plain nanoseconds. You’d instead use it like d.Seconds() to get whichever unit you desire.

  • vtr@programming.dev
    link
    fedilink
    English
    arrow-up
    3
    arrow-down
    1
    ·
    1 year ago

    That seems akin to commenting. The problem with this approach is that text is not code. It’s very easy to forget to change text. In that case it becomes the worst of both worlds, you have a variable name that actually misleads you.

    Much safer than this is to encode this kind of information into the code itself in such a way the program won’t compile of the types are incorrect.

    • 𝕊𝕚𝕤𝕪𝕡𝕙𝕖𝕒𝕟@programming.devOP
      link
      fedilink
      English
      arrow-up
      4
      arrow-down
      1
      ·
      1 year ago

      I understand what you mean, and I even agree with it, but just to be a little pedantic, variable names are code, or at least they are more code than comments or docs.

      But yes, encoding units into the type system is a much better solution. It doesn’t work however for config options, environment variables or CLI switches.

  • Kresten@feddit.dk
    link
    fedilink
    English
    arrow-up
    1
    ·
    1 year ago

    It’s so annoying when you have to figure out what unit a variable is describing :(

  • mirisbowring@lemmy.primboard.de
    link
    fedilink
    English
    arrow-up
    2
    arrow-down
    1
    ·
    1 year ago

    But what if the FileSize can be „1G“, „1024M“, 518K“, etc.?

    Documentation itself is much more important and modern IDEs and Editors will show you what to type in :)

  • Tim@lemmy.timwaterhouse.com
    link
    fedilink
    English
    arrow-up
    1
    ·
    1 year ago

    The better fix is to try to use types that represent those units or data types (e.g. duration instead of ms). Makes it harder to accidentally use the wrong units and documents the code / intent better.