DEV Community

Discussion on: ✨ 5 damn easiest soft skills💡 needed to become a 10X🔥...Yes...10X🔥 Software Engineer ✔️

Collapse
 
idanarye profile image
Idan Arye

The comments OP talks about in the second point seem to be documentation comments - a totally different beast than the comments clean code advocates warn about.

Collapse
 
mrsaeeddev profile image
Saeed Ahmad

It refers to comprehensive comments. It doesn't matter whether they are to serve as a basis for documentation or making code clearer to new developer.

Thread Thread
 
idanarye profile image
Idan Arye

It does matter. According to the clean code philosophy, you should avoid writing comments to make the code clearer and instead refactor the code so that one wouldn't need comments to understand it. Documentation comments are for generating API docs, so it makes sense to have them even if you follow clean code principles.

Thread Thread
 
mrsaeeddev profile image
Saeed Ahmad

Yeah. It matters but I am in favour of what I said.