Why should I use comments when documenting python?

Question

There are two ways to document a module, function, or class in the code itself: comments and docstrings.

Docstrings are more functional, as they can be accessed via the help() function, while comments can only be accessed in the source code.

When should comments be used in place of docstrings?

Comments aren't documentation. Comments are for people reading the code. Documentation is for people using it. — user2357112
– user2357112, Commented Apr 21, 2019 at 6:04
I think the question is unclear. I mean docstrings that exist inside the source code, defined '''xxxx''' — Alec
– Alec, Commented Apr 21, 2019 at 6:05

gmds · Accepted Answer · 2019-04-21 06:05:30Z

1

Docstrings are meant to explain what a function does, in terms of what kinds and types of values it takes and returns, from a user's perspective.

Comments, on the other hand, being in the body of the source code, will only be visible to those actually reading it, and accordingly serve to explain how it does what it does.

answered Apr 21, 2019 at 6:05

gmds

20k4 gold badges37 silver badges65 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Why should I use comments when documenting python?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related