Programming

17524 readers

428 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev

founded 1 year ago

MODERATORS

snowe@programming.dev

Ategon@programming.dev

MaungaHikoi

A quick tip for better variable names (programming.dev)

submitted 1 year ago* (last edited 1 year ago) by sisyphean@programming.dev to c/programming@programming.dev

25 comments fedilink hide all child comments

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

you are viewing a single comment's thread
view the rest of the comments

[–] sisyphean@programming.dev 4 points 1 year ago

In that case I would call the variable fileSizeWithUnit and also document what the possible units are. I wouldn't say that documentation is categorically more important than good naming. Both are different aspects of good software development.