mrw the style guide requires documentation for every function
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
My “why” comments:
// This is here because if I remove it, the whole server panics, no idea why. So don't delete it.
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?
It’s self-documenting.
Yet another useless use of
cat…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”
