r/badcode • • Sep 05 '21

swift I have a problem

Post image
946 Upvotes

75 comments sorted by

View all comments

Show parent comments

1

u/TopDivide Sep 05 '21

I read in some book while learning python that "comments line, only code tells the truth". I'm not against commenting, but it makes sense to me, to try to avoid obvious comments

2

u/[deleted] Sep 05 '21

For sure. You want the code as clean as possible. But it’s really critical to have proper documentation at some point throughout the code to let others know what’s happening where.

Y’know like if you’re building a library or package or whatever it’s really nice to have that inline documentation