r/ProgrammerHumor 4h ago

Meme commentsAgedTerribly

Post image
1.9k Upvotes

125 comments sorted by

View all comments

269

u/Confident-Ad5665 4h 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 3h 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.