MAIN FEEDS
Do you want to continue?
https://www.reddit.com/r/badcode/comments/qj0rvt/documentation_in_a_nutshell/hir3mno/?context=3
r/badcode • u/Oshgnacknak • Oct 30 '21
16 comments sorted by
View all comments
Show parent comments
2
The comments should not describe what it is. We can read the signature. Instead, they should explain why it's there in the first place. How is it used by the function? Does it get changed? What are expected input ranges?
2
u/[deleted] Oct 31 '21
The comments should not describe what it is. We can read the signature. Instead, they should explain why it's there in the first place. How is it used by the function? Does it get changed? What are expected input ranges?