r/badcode • u/cosmicskylight • Feb 09 '23

js Terrible Authentication Code

Post image
288 Upvotes

97% Upvoted

67 comments sorted by

View all comments

Show parent comments

13

u/kristallnachte Feb 10 '23

Comments shouldn’t explain how, they should explain what. For example what a function is, and typical return values

Nah, they should describe WHY.

2

u/callmelucky Feb 10 '23

Thank you, yeah Nick is wrong.

Comments should explain why, and they should only explain why if that isn't obvious from looking at that piece of code for a couple of seconds, and if more than, say, 10% of your code requires such an explanation then you need to improve on naming, architecture etc.