📢
20
c/career-advice•mason798mason798•1mo ago

That time a senior dev told me my code comments were too long

Been at this dev job for about 2 years now. I always wrote huge paragraphs explaining every single line in my code. My lead pulled me aside after a code review and said nobody reads those novels, just say what the function does in one line. So I cut it down to short notes only when something is tricky. Has anyone else gotten feedback that made you completely change how you write code?
2 comments

Log in to join the discussion

Log In
2 Comments
robinson.holly
Honestly, what helped me was writing comments like I'm explaining it to my future self.
5
abby_scott
abby_scott1mo ago
That whole mindset works for a ton of stuff, not just code.
2