Python Comments: Importance and Types

Python Comments

Python Comments in lines are considered as the lines of code that will be neglected by the interpreter while the program is executed.

Therefore, comments will improve the readability of the code and could enable the programmers to understand the code. This article has listed the Python Comments and their types.

What are the Types of Comments in Python?

The three types of comments in Python are:

a. Single-line Comments

b. Multiline Comments

c. String Literals

d. Docstring Comments

What are the Examples for Comments in Python

The example below will tell us that the Python comments are neglected by the Python Interpreter during the program execution.

# sample comment 
name = "Skillvertex"
print(name) 

Output

Skillvertex

Why are Comments used in Python?

Comments play a vital role in programming, languages and every language has several ways of using comments.

Several uses of comments in Python are the following:

a. Improve the code readability

b. Explains code to others

c. Helps to analyze the code if known for some time

d. Note down the steps and the requirements for the function

e. Sharing the code with fellow developers

f. Collaboration with multiple people

What are the Types of Comments in Python

The different types of comments and their relevance are provided below:

1. Single -Line Comments

Python single-line comments will begin with the hashtag symbol and no white space is required. # will be needed until the end of the line. However, if the comment has gone beyond one line, it is necessary to put a hashtag on the next line and this will be carried on to the Python Comment.

Hence, python single-line comments will be very beneficial for providing short explanations for variables, functions, declarations, and expressions. Refer to the code snippet below to understand the single-line comment.

Example

# Print “Skillvertex !” to console 
print("Skillvertex") 

Output

Skillvertex

2. Multi-Line Mentions

Python won’t give the option for the multiline comments. So, there are several ways to write multiline comments.

a) Multiline comments using multiple hashtags (#)

It is possible to use the multiple hashtag # for writing multiline comments in Python. Each line will be denoted as a single-line comments

# Python program to demonstrate 
# multiline comments 
print("Multiline comments")

Output

Multiline comments

3. String Literals

Python will neglect the string literals and won’t be assigned to a variable. Thus, it is possible to use the string literals as Python Comments.

a. Single-line comments with the string literals

While executing the code, there won’t be any output, and use the strings with the triple quotes (”””) as the multiline comments

'This will be ignored by Python'

b. Multiline Comments using the string literals

""" Python program to demonstrate 
 multiline comments"""
print("Multiline comments")

Output

Multiline comments

4. Docstring

Python Docstring is referred to as the string literals along with the triple quotes and will be shown right after the function. Hence, it functions to associate documentation and will be written with the help of Python modules, classes, and methods.

Hence, it will be added below the functions, modules, or classes to describe what they do. The docstring will be created and then will be accessible through the  __doc__ attribute.

Example

def multiply(a, b): 
    """Multiplies the value of a and b"""
    return a*b 
  
  
# Print the docstring of multiply function 
print(multiply.__doc__) 

Output

Multiplies the value of a and b

Conclusion

In conclusion, comments in Python are like helpful notes you write in your code to explain things to yourself and others. They don’t affect how the program runs, but they make your code easier to understand.

Python Comments- FAQs