Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
@devios1 I believe that is where the commit mesage/associated PR/associated tickets comes in?
-
devios157776y@frozentruth If you're suggesting that commit messages on their own are a proper place to explain overarching architectural decisions, I have to disagree.
You're right that writing comments explaining what the code is doing when it's right in front of you is rather pointless (unless it's a complicated algorithm in which case it's still helpful to explain it in words). What's more important is explaining the reason something is done if it's not obvious so that someone picking up the code can have that as a starting basis, rather than have to figure it out on their own.
Presumably we all know how to read code. But what we can't do is read other developers' minds. Comments are most helpful when they facilitate that communication between devs (or even a future version of the same dev). If there's some understanding that is in their heads while they are writing something, but that does not explicitly come out in the code, that's what you want to capture in the comments.
Related Rants
I just wanna smash their head with a metal chair then shove their own keyboard up their fucking ass... Sideways while they choke on a rusty knife...
Lazy cunts
joke/meme
lazy
no comments