DEV Community

Discussion on: 10 Concerns & How we can make the whole React codebase cleaner

Collapse
 
ibibgor profile image
Oscar

For the comments tip you gave, I have to say that we in our team allow comments. But they should not explain what is done at a specific code block but explain WHY it was done that way. Maybe it's a little hacky solution but necessary because of dependencies. Therefor other developer should not waste time on trying to refactor some code only to realise that this code is "the currently best option"

But: Nice post! I'm happy that we do the most of those patterns and tips ourself already :)

Collapse
 
ashishsurana profile image
Ashish Surana

Absolutely correct. 100% Agree with you. Comments are not a bad practice at all, but enforcing comments above every single function, variable declaration leads to bad code. We are also following comments for a business logic explanation so that other engineers can quickly get the context and understand the use case.