Comments
Comments
Comments:
In Python, you can add comments to your code to provide additional information or context for other developers or for yourself in the future. Comments are lines of text that are ignored by the Python interpreter and are intended solely for human readers.
There are following ways to add comments in Python:
- Single-line comments: To add a comment to a single line of code, use the “#” symbol at the beginning of the line. For example:
x = 5
# This is a comment
- Multi-line comments: To add a comment that spans multiple lines, use triple quotes (“”” or ”’) at the beginning and end of the comment. For example:
"""
This is a multi-line comment
It can span multiple lines """
It’s a good practice to include comments in your code to make it more readable and understandable. Comments can explain the purpose of a block of code, describe the functionality of a function or class, provide instructions for using the code, or document any assumptions or limitations.
- Docstring comments: A docstring is a special type of comment that provides documentation for functions, classes, and modules. Unlike regular comments, docstrings are stored as an attribute of the function, class, or module, and can be accessed at runtime.
A docstring is typically placed at the beginning of a function, class, or module, immediately following the definition line and any import statements. A docstring is enclosed in triple quotes (“”” or ”’) and can span multiple lines. Here’s an example of a docstring for a function:
def greet(name):
"""
This function takes a name as input and returns a greeting message.
"""
return f"Hello, {name}!"