Docstring
Definition
A docstring is a special type of comment used to describe the purpose and functionality of a module, function, class, or method in Python. It is enclosed within triple quotes and can span multiple lines.
5 Must Know Facts For Your Next Test
- Docstrings are enclosed within triple quotes, allowing them to span multiple lines.
- They are the first statement in a module, function, class, or method definition.
- Python's built-in functions like help() use docstrings to provide documentation.
- Docstrings can be accessed using the __doc__ attribute of the object they describe.
- Unlike regular comments that start with #, docstrings are stored as part of the object's metadata.
Review Questions
- What is the primary use of a docstring in Python?
- How do you access a function's docstring at runtime?
- How do docstrings differ from regular comments in Python?
"Docstring" appears in:
Study guides (1)
Related terms
Comment: Text in a program that is not executed by the interpreter and is used to explain code. In Python, comments start with the # symbol.
__doc__: A special attribute that stores an object's docstring and allows it to be accessed programmatically.
help(): A built-in Python function that displays documentation for modules, classes, functions, keywords, etc., often utilizing their docstrings.
