Comment on How to properly document code?

heeplr@feddit.de ⁨7⁩ ⁨months⁩ ago

I find too verbose comments less annoying than no comments.

Try to describe the bigger picture. Good comments allow understanding the current portion of the code without reading other code.

Also add comments later if you find yourself having to read other code to understand the code you’re currently looking at.

Comments are also a good place to write out abrevations/acronyms.

Never optimize for sourcecode size.

source
Sort:hotnewtop