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

[–] [email protected] 7 points 2 years ago

My "why" comments:

// This is here because if I remove it, the whole server panics, no idea why. So don't delete it.

[–] [email protected] 1 points 2 years ago (1 children)

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.

[–] [email protected] 3 points 2 years ago

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

[–] [email protected] 6 points 2 years ago* (last edited 2 years ago) (1 children)

@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);
}`

[–] [email protected] 2 points 2 years ago* (last edited 2 years ago)

mrw the style guide requires documentation for every function

[–] tiny_fingers 4 points 2 years ago (1 children)

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'.

[–] [email protected] 2 points 2 years ago

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

[–] [email protected] 3 points 2 years ago

It's self-documenting.

[–] [email protected] 2 points 2 years ago

Comments? What are comments?

[–] [email protected] 2 points 2 years ago

Yet another useless use of cat...

[–] [email protected] 0 points 2 years ago* (last edited 2 years ago)

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"

load more comments