614
Aaargh....my eyes......my eyes......
(lemmy.world)
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
this post was submitted on 28 Mar 2024
614 points (98.1% liked)
Programmer Humor
32710 readers
409 users here now
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
- Posts must be relevant to programming, programmers, or computer science.
- No NSFW content.
- Jokes must be in good taste. No hate speech, bigotry, etc.
founded 5 years ago
MODERATORS
Variable names shouldn't need comments, period. You don't want to look it up every time this variable is used in code, just to understand what it holds. Of course there are always exceptions, but generally names should be descriptive enough to not need additional explanation.
And context can also come from names of other things, e.g. name of a class / namespace that holds this variable. For example
AccessibilitySettings.HighContrast, where AccessibilitySettings holds all options related to accessibility.Yeah but “HighContrast” is enough; if you need to know the Why and not the What you can find a comment at the definition. There’s not need to carry the whole Wiki article everytime you need to use the variable.
I think the argument about "for accessibility" is missing the point a little bit and a common mistake most developers make.
You should endeavour to make your interface accessible by default. You shouldn't be thinking in terms of "okay here's the design and here's the design that's accessible", you should be considering accessibility in all of your designs.
Now that's usually a bit harder with games because you have styles and themes that you don't want to detract from, but if your interface causes accessibility issues, it's generally going to be bad for people that don't have accessibility needs as well.
Accessibility benefits everyone.