26 ms·
I run into this problem as well I'll often come across something I wrote a few years ago and struggle to remember why I wrote it that way. I've learned to add
by bigger_cheese 3y ago
I run into this problem as well I'll often come across something I wrote a few years ago and struggle to remember why I wrote it that way.
I've learned to add comments to my code - from what I see commenting code is frowned upon by a certain subset of developers but I've taught myself that whenever I am doing something subtle or unintuitive to add a short comment explaining what the code is doing, for every potentially unnecessary comment I've added I've also saved myself time when I've had to come back to something months or years later and been able to refer back to the comment.
- arcanemachiner 3y ago> from what I see commenting code is frowned upon by a certain subset of developers I am not able rightly to apprehend the kind of confusion of ideas that could provoke such a... belief.
- bigger_cheese 3y agoThe main argument seems to be comments should left with the commit message and not "inline" i.e mixed with the code. Personally I make heavy use of inline style comments.
- citizenpaul 3y agoI've worked in tech my whole life and never heard a dev make these comments are bad claims. I only work in the boring world though. Is this a startup or FAANG or silicon valley thing?
- dmarchand90 3y agoIn clean code there is a chapter about eliminating useless comments. I think this has some merits. Think of the following made up example: sum = sum_two_numbers(number1, number2) Probably doesn't need a comment. The other argument is that comments need to be maintained and are subject to decay. E.g. the code they are commenting on changes. The book goes into other examples but i think the idea isn't to eliminate comments but to be thoughtful and judicious in which you use
- deleted 3y ago[deleted]