DEV Community

Discussion on: I love to document my code. Am I doing it wrong?

 
alchermd profile image
John Alcher

I'm not too sure if this is worth taking even 3 minutes from someone else's times to discuss whenever the comment was needed or not.

Setting up standards is an important point for a development team. If the guy that writes comments like these have a reason for doing so, he should discuss it with the team for standardization.

Thread Thread
 
clovis1122 profile image
José Clovis Ramírez de la Rosa

I agree that setting up standards is very important, thanks for your thoughts.

Thread Thread
 
idoshamun profile image
Ido Shamun

I totally agree with John, I think comments add much clutter to code and you have to use them carefully. Writing self explanatory code is not an easy task so sometimes comments can cover it.
But eventually it is up to the team culture. If your team likes to comment so go ahead and just do it