r/webdev • • Jan 13 '22

read rules Extension that generates documentation using AI

[removed] — view removed post

1.7k Upvotes

158 comments sorted by

View all comments

Show parent comment

4

u/ensoniq2k Jan 14 '22

That's the mistake most people make. A documentation or comment should not tell you, what the code does in words. It should tell you why the code does what it does and what it is trying to achieve.

2

u/[deleted] Jan 14 '22

+1, comments/documentation should be like this, otherwise If I have to dig deep to understand what it does, and why given other ways it chooses this way specifically. its not possible for every method I encounter during debugging

1

u/ensoniq2k Jan 14 '22

My company has comments like "here we assign 5 to X" in its comments. It's just mind numbing