That comment about my code comments actually made me rethink them

My neighbor Dave, who's been a dev for like 15 years, saw me grinding through a Python course last Tuesday and said 'your comments read like a diary, not a manual.' At first I was kinda annoyed, but then I looked back at my last 3 practice projects and yeah, I was basically writing 'this is the part where I got stuck' instead of explaining what the function does. It hit different because he wasn't being mean, he was pointing out that future me (or anyone else) would have no clue what my logic was trying to do. Now I'm trying to comment like I'm explaining it to a total stranger, and honestly it's way harder than the code itself. Has anyone else had that moment where a tiny piece of feedback changed how you write stuff for beginners?

1 comments

1 Comment

lucas49828d ago

Ha! Wait til you see his comments on his own commit messages.