DEV Community

Discussion on: Coding practices your future self will love you for

nokiz profile image
Nando AM

Don't write stupid comments on code, but write comments.

mnivoliez profile image

I should add "do not write in comment what you could have write in code".
That include the name of function/variables, the types (if it's a typed language that is), the exception that can occur, any optional result, constant arguments.. etc...

mohanarpit profile image
Arpit Mohan Author

Couldn't agree more. Comments should describe the "Why" and not the "How". The "How" is already present in code.