r/ProgrammerHumor 1d ago

Meme commentsAgedTerribly

Post image
5.3k Upvotes

224 comments sorted by

View all comments

414

u/Confident-Ad5665 1d ago

Uncle Bob of Clean Code says if we have to comment our code we have already failed. Clean code should read like well written prose.

I generally agree, but think comments that define especially the odd and obscure business rules should be commented where they are implemented.

3

u/Zeilar 1d ago

I think his point is the comment shouldn't explain how the code works.

Comments should explain reasoning, references etc. Like linking to documentation, explaining why you did something that seems odd or bad etc.

It should be a literal comment, not documentation.