How to write Comments in Python3?
Last Updated :
07 Apr, 2025
Comments are text notes added to the program to provide explanatory information about the source code. They are used in a programming language to document the program and remind programmers of what tricky things they just did with the code and also help the later generation for understanding and maintenance of code. The compiler considers these as non-executable statements. Since comments do not execute, when you run a program you will not see any indication of the comment in the output.
Syntax: The hash(#) symbol denotes the starting of a comment in Python.
# This is a comment in Python
Example:
python
# This is the syntax of a comment in Python
print("GFG")
# Comments dont have any effect on the interpreter / output
Output :
GFG
Comments should be made at the same indent as the code it is commenting on.
python
def GFG():
# Since, this comment is inside a function
# It would have indent same as the function body
print("GeeksforGeeks")
for i in range(1, 2):
# Be careful of indentation
# This comment is inside the body of for loop
print("Welcome to Comments in Python")
# This comment is again outside the body
# of function so it wont have any indent.
print("Hello !!")
GFG()
OutputHello!!
GeeksforGeeks
Welcome to Comments in Python
Types of Comments
1. Single-Line Comments: Comments starting with a ‘#’ and whitespace are called single-line comments in Python. These comments can only stretch to a single line and are the only way for comments in Python. e.g.
# This a single line comment.
2. Multi-line (Block) comments: Unlike other programming languages Python doesn’t support multi-line comment blocks out of the box. However we can use consecutive # single-line comments to comment out multiple lines of code. Some examples of block comments-
# This type of comments can serve
# both as a single-line as well
# as multi-line (block) in Python.
3. Inline Style comments: Inline comments occur on the same line of a statement, following the code itself. Generally, inline comments look like this:
x = 3 # This is called an inline comment
a = b + c # Adding value of 'b' and 'c' to 'a'
4. Docstring comments: Python documentation strings (or docstrings) provide a convenient way of associating documentation with Python modules, functions, classes, and methods. It’s specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, the docstring should describe what the function does, not how.
Example:
python
def my_function():
"""Demonstrates docstrings and does nothing really."""
return None
print("Using __doc__:")
print(my_function.__doc__)
print("Using help:")
help(my_function)
Output:
Using __doc__:
Demonstrates docstrings and does nothing really.
Using help:
Help on function my_function in module __main__:
my_function()
Demonstrates docstrings and does nothing really.
Advantages and Uses of Comments:
Planning and reviewing: In the comments, we can write the pseudocode which we planned before writing the source code. Pseudocode is a mixture of natural language and high-level programming language. This helps in reviewing the source code more easily because pseudocode is more understandable than the program.
Example:
python
# This function is adding two given numbers
def addition(a, b):
# storing the sum of given numbers in 'c'.
c = a + b
# returning the sum here
return c
# passing the value of a and b to addition()
a = 10
b = 3
sum = addition(a, b)
# printing the sum calculated by above function
print(sum)
Output :
13
Debugging: The brute force method is a common method of debugging. In this approach, print statements are inserted throughout the program to print the intermediate values with the hope that some of the printed values will help to identify the errors. After doing debugging we comment on those print statements. Hence comment is also used for debugging.
python
a = 12
if(a == 12):
print("True")
# elif(a == 0):
# print("False")
else:
print("Debugging")
Output :
True
Similar Reads
Python | os.write() method
OS module in Python provides functions for interacting with the operating system. OS comes under Python’s standard utility modules. This module provides a portable way of using operating system dependent functionality. os.write() method in Python is used to write a bytestring to the given file descr
2 min read
How to use String Formatters in Python
In Python, we use string formatting to control how text is displayed. It allows us to insert values into strings and organize the output in a clear and readable way. In this article, we’ll explore different methods of formatting strings in Python to make our code more structured and user-friendly. U
3 min read
Python | os.writev() method
OS module in Python provides functions for interacting with the operating system. OS comes under Python’s standard utility modules. This module provides a portable way of using operating system dependent functionality. os.writev() method in Python is used to write the contents of specified buffers t
2 min read
Python - Write Bytes to File
Files are used in order to store data permanently. File handling is performing various operations (read, write, delete, update, etc.) on these files. In Python, file handling process takes place in the following steps: Open filePerform operationClose file There are four basic modes in which a file c
2 min read
How to add Elements to a List in Python
In Python, adding elements to a list is a common operation that can be done in several ways. One of the simplest methods is using the append() method. In this article we are going to explore different methods to add elements in the list. Below is a simple Python program to add elements to a list usi
3 min read
Writing to file in Python
Writing to a file in Python means saving data generated by your program into a file on your system. This article will cover the how to write to files in Python in detail. Creating a FileCreating a file is the first step before writing data to it. In Python, we can create a file using the following t
4 min read
How to create constant in Python
Python lacks built-in constant support, but constants are typically represented using all-uppercase names by convention. Although they can technically be reassigned, it’s best practice to avoid modifying their values. This convention helps indicate that such variables should remain unchanged through
2 min read
How do we create multiline comments in Python?
Comments are pieces of information present in the middle of code that allows a developer to explain his work to other developers. They make the code more readable and hence easier to debug. Inline Comment An inline comment is a single line comment and is on the same line as a statement. They are cre
3 min read
Python PRAW - Downvoting a comment in Reddit
In Reddit, we can post a comment to any submission, we can also comment on a comment to create a thread of comments. We can either upvote or downvote a comment. Here we will see how to downvote a comment using PRAW. We will be using the downvote() method of the Comment class to downvote a comment. d
2 min read
How to use Function Decorators in Python ?
In Python, a function can be passed as a parameter to another function (a function can also return another function). we can define a function inside another function. In this article, you will learn How to use Function Decorators in Python. Passing Function as ParametersIn Python, you can pass a fu
3 min read