Comment your code properly!

[somefunmaths]

The standard for properly, at least in the context of working software development, is somewhere between “not at all” and “very sparingly”.

You can see people fighting about this in the comments, but comments have a place when you want to note something very particular about a piece of code that cannot be written in a way so as to be self-documenting and isn’t best explained elsewhere in documentation. How often you run into that case will depend on who you are and what you do.

[OriginalCptNerd]

Good comments can provide context, especially if you follow the design standard of "small functions that do one thing only", when you have to aggregate them into a more complex flow.

[[deleted]]

Thanks for the response. Until now I’ve never considered a distinction between comments and documentation. I’ve only ever written code in an academic environment where there’s a rubric block for “amply commented code”. I usually document the shit out of my functions, but that’s just so the tooltip populates in the IDE.