H
12

Just realized my code comments were way too vague after a code review in Portland last week

I've been coding for about 6 months and always thought my comments were fine. Then during a group code review at a meetup in Portland, this guy pointed out that my comment '// loops through data' told him nothing useful. He showed me how writing comments like '// gets all users who signed up in March 2023 and filters out admins' actually helps future me understand what I was thinking. Has anyone else had a code review totally change how they comment?
2 comments

Log in to join the discussion

Log In
2 Comments
ivan211
ivan21127d ago
Yeah that happened to me too, now I write comments like I'm explaining it to my future hungover self.
8
ben436
ben43627d ago
Wait, did that really help you see your comments differently too?
3