Comment by Shraal
3 days ago
Time and risk of comments/docs becoming outdated and doing more harm than good.
I'm impartial in this discussion but that's usually how the counter argument goes.
3 days ago
Time and risk of comments/docs becoming outdated and doing more harm than good.
I'm impartial in this discussion but that's usually how the counter argument goes.
The counter argument is bunk, you change the comments when you change the code. It’s not hard. If you forget, them a reviewer will notice. If not, then you aren’t focusing enough attention on the finer details of a project, to your detriment.
Personally, I find that a lot of good, accurate comments and documentation helps me to trust a code base more because I can see that the devs cared and focused on the finer details rather than just tossing code over a fence at me.