48
No more code headers?
(midwest.social)
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 31 Jul 2023
48 points (96.2% liked)
Programming
17314 readers
160 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
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
Its wild to me that some people hear "your code should be self documenting" and take that to mean "never write comments".
All self documenting should mean is I can look at a method and get a general understanding of what it does, and it shouldn't have any unknown functionality. Specific implementations, design quirks, choices that might only make sense if you know business context should all be comments in your code.
On the other side of all that I worked with someone who insisted methods were documented college style, the "authors" name, date it was written, what it does, why it's here, our star sign. I hate that just as much, so much clutter.
It's the same people that hear "security by obscurity is not security" and take it to mean "publicity is more secure than obscurity". A key being under a door mat is bad but putting it on top of the mat because "obscurity isn't security" is silly.
Edit: A better example is having a hidden door with a look is still more secure than having a non-hidden door with a lock.