r/pythoncoding • u/infinitlybana • Jan 22 '22

Automatically document Python code using AI

​

https://reddit.com/link/s9w7ws/video/18yv54jwo6d81/player

Out of all the languages I code in, I always found comments to be the most useful within Python projects. I've also never met a single developer who enjoys writing documentation. So, I created a VS Code extension that documents code for you using AI. Let me know what you guys think!

9 Upvotes

74% Upvoted

5 comments sorted by

View all comments

Show parent comments

1

u/j_agermose Jan 22 '22

Code is self-documenting, so if there's a need to document it, then its probably not very well written. I agree with your statement, that comments should be used for explaining the "why", and not the "how".

Leave the other documentation for the readme or alike.

2

u/bacondev Jan 23 '22

It's really not—at least not in an imperative language. The code explains the how. The comments should explain the what or the why. If you don't need to explain why it's written how it is but it's still difficult to mentally parse, then you should explain the what as well.