Comments should almost always be reserved to "why" and not "what" or "how". Give extra context that can not be brought in another way. The rest should be clear from the code
this post was submitted on 16 Jun 2023
120 points (98.4% liked)
Programmer Humor
19557 readers
779 users here now
Welcome to Programmer Humor!
This is a place where you can post jokes, memes, humor, etc. related to programming!
For sharing awful code theres also Programming Horror.
Rules
- Keep content in english
- No advertisements
- Posts must be related to programming or programmer topics
founded 1 year ago
MODERATORS
My "why" comments:
// This is here because if I remove it, the whole server panics, no idea why. So don't delete it.
I upvoted this, but actually I hardly ever see this style of commenting. Maybe it's because I never got very far into corporate coding.
At least in my experience it's more people just stop leaving comments. Best place I worked had comment review as a part of code review, that was nice
@odama626 when my brain goes in auto-mode, mine ends up like:
`// opens dialog window
openDialogWindow(){
// set dialog config
const config = new DialogWindowConfig({...});
// open window
dialogWindow.Open(config);
}`
mrw the style guide requires documentation for every function
Heheh. Sometimes if it's getting close to going home time, but I just had an epiphany, I'll add comments to my code so I can remember my train of thought for the next day. Then I promptly forget to remove the comment after I add the code because I get pulled into some other 'emergency'.
I do this too, will have a list of todos. There is an atlassian vscode extension that lets you create tickets from todos though so that can be pretty helpful
Comments? What are comments?
Yet another useless use of cat...
It's self-documenting.
I read peoples code submit descriptions and a bunch are extremely detailed, then the ones after from the same user same day are usually "oh this doesn't work, should work now" or more regularly "iwqrjtqwiuht"
view more: next ›