Python Tutorial

Introduction Python Features Python Applications Python System Requirements Python Installation Python Examples Python Basics Python Indentation Python Variables Python Data Types Python IDE Python Keywords Python Operators Python Comments Python Pass Statement

Python Conditional Statements

Python if Statement Python elif Statement Python If-else statement Python Switch Case

Python Loops

Python for loop Python while loop Python Break Statement Python Continue Statement Python Goto Statement

Python Arrays

Python Array Python Matrix

Python Strings

Python Strings Python Regex

Python Built-in Data Structure

Python Lists Python Tuples Python Lists vs Tuples Python Dictionary Python Sets

Python Functions

Python Function Python min() function Python max() function Python User-define Functions Python Built-in Functions Python Recursion Anonymous/Lambda Function in Python python apply() Function Python lambda() Function

Python File Handling

Python File Handling Python Read CSV Python Write CSV Python Read Excel Python Write Excel Python Read Text File Python Write Text File Read JSON File in Python

Python Exception Handling

Python Exception Handling Python Errors and exceptions Python Assert

Python OOPs Concept

OOPs Concepts in Python Classes & Objects in Python Inheritance in Python Polymorphism in Python Python Encapsulation Python Constructor Python Super function Python Static Method Static Variables in Python Abstraction in Python

Python Iterators

Iterators in Python Yield Statement In Python Python Yield vs Return

Python Generators

Python Generator

Python Decorators

Python Decorator

Python Functions and Methods

Python Built-in Functions Python String Methods Python List Methods Python Dictionary Methods Python Tuple Methods Python Set Methods

Python Modules

Python Modules Python Datetime Module Python Math Module Python Import Module Python Time Module Python Random Module Python Calendar Module CSV Module in Python Python Subprocess Module Python Subprocess

Python MySQL

Python MySQL Python MySQL Client Update Operation Delete Operation Database Connection Creating new Database using Python MySQL Creating Tables Performing Transactions

Python MongoDB

Python MongoDB

Python SQLite

Python SQLite

Python Data Structure Implementation

Python Stack Python Queue Python Linked List Python Hash Table Python Graph

Python Advance Topics

Speech Recognition in Python Face Recognition in Python Python Linear regression Python Rest API Python Command Line Arguments Python JSON Python Virtual Environment Type Casting in Python Python Collections Python Commands Python Data Visualization Python Debugger Python DefaultDict Python Enumerate

Python 2

What is Python 2

Python 3

Anaconda in Python 3 Anaconda python 3 installation for windows 10 List Comprehension in Python3

Misc

Python PPTX Python Pickle Python Seaborn Python Coroutine Python EOL Python Infinity Python math.cos and math.acos function Python Project Ideas Based On Django Reverse a String in Python Reverse a Number in Python Python Word Tokenizer Python Trigonometric Functions Python try catch exception GUI Calculator in Python Implementing geometric shapes into the game in python Installing Packages in Python Python Try Except Python Sending Email Socket Programming in Python Python CGI Programming Python Data Structures Python abstract class Python Compiler Python K-Means Clustering NSE Tools In Python Operator Module In Python Palindrome In Python Permutations in Python Pillow Python introduction and setup Python Functionalities of Pillow Module Python Argmin Python whois Python JSON Schema Python lock Return Statement In Python Reverse a sentence In Python tell() function in Python Why learn Python? Write Dictionary to CSV in Python Write a String in Python Binary Search Visualization using Pygame in Python Latest Project Ideas using Python 2022 Closest Pair of Points in Python ComboBox in Python Python vs R Best resources to learn Numpy and Pandas in python Check Letter in a String Python Python Console Python Control Statements Convert Float to Int in Python using Pandas Difference between python list and tuple Importing Numpy in Pycharm Python Key Error Python NewLine Python tokens and character set Python Strong Number any() Keyword in python Best Database in Python Check whether dir is empty or not in python Comments in the Python Programming Language Convert int to Float in Python using Pandas Decision Tree Classification in Python End Parameter in python __GETITEM__ and __SETITEM__ in Python Python Namespace Python GUI Programming List Assignment Index out of Range in Python List Iteration in Python List Index out of Range Python for Loop List Subtract in Python Python Empty Tuple Python Escape Characters Sentence to python vector Slicing of a String in Python Executing Shell Commands in Python Genetic Algorithm in python Get index of element in array in python Looping through Data Frame in Python Syntax of Map function in Python After Python What Should I Learn Python AIOHTTP Alexa Python Artificial intelligence mini projects ideas in python Artificial intelligence mini projects with source code in Python Find whether the given stringnumber is palindrome or not First Unique Character in a String Python Python Network Programming Python Interface Python Multithreading Python Interpreter Data Distribution in python Flutter with tensor flow in python Front end in python Iterate a Dictionary in Python Iterate a Dictionary in Python – Part 2 Allocate a minimum number of pages in python Assertion Errors and Attribute Errors in Python Checking whether a String Contains a Set of Characters in python Python Control Flow Statements *Args and **Kwargs in Python Bar Plot in Python Conditional Expressions in Python Function annotations() in Python How to Write a Configuration file in Python Image to Text in python import() Function in Python Import py file in Python Multiple Linear Regression using Python Nested Tuple in Python Python String Negative Indexing Reading a File Line by Line in Python Python Comment Block Base Case in Recursive function python ER diagram of the Bank Management System in python Image to NumPy Arrays in Python NOT IN operator in Python One Liner If-Else Statements in Python Sklearn in Python Cube Root in Python Python Variables, Constants and Literals What Does the Percent Sign (%) Mean in Python Creating Web Application in python Notepad++ For Python PyPi TensorFlow Python | Read csv using pandas.read_csv() What is online python free IDE What is Python online compiler Run exec python from PHP What are the Purposes of Python Python Ternary Operators Self in Python Python vs Java Python Modulo Python Packages Python Syntax Python Uses Python Bitwise Operators Python Identifiers Python Matrix Multiplication Python AND Operator Python Logical Operators Python Multiprocessing Python Unit Testing __init__ in Python Advantages of Python Is Python Case-sensitive when Dealing with Identifiers Python Boolean Python Call Function Python History Python Image Processing Python main() function Python Permutations and Combinations Difference between Input() and raw_input() functions in Python Conditional Statements in python Confusion Matrix Visualization Python Python Algorithms Python Modules List Difference between Python 2 and Python 3 Is Python Case Sensitive Method Overloading in Python Python Arithmetic Operators Assignment Operators in Python Is Python Object Oriented Programming language Division in Python Python exit commands Continue And Pass Statements In Python Colors In Python Convert String Into Int In Python Convert String To Binary In Python Convert Uppercase To Lowercase In Python Convert XML To JSON In Python Converting Set To List In Python Covariance In Python CSV Module In Python Decision Tree In Python Difference Between Yield And Return In Python Dynamic Typing In Python What is Python compiler GDB Python coding platform Python Classification Python | a += b is not always a = a + b PyDev with Python IDE Character Set in Python Best Python AI Projects _dict_ in Python

How to

How to Substring a String in Python How to Iterate through a Dictionary in Python How to convert integer to float in Python How to reverse a string in Python How to take input in Python How to install Python in Windows How to install Python in Ubuntu How to install PIP in Python How to call a function in Python How to download Python How to comment multiple lines in Python How to create a file in Python How to create a list in Python How to declare array in Python How to clear screen in Python How to convert string to list in Python How to take multiple inputs in Python How to write a program in Python How to compare two strings in Python How to create a dictionary in Python How to create an array in Python How to update Python How to compare two lists in Python How to concatenate two strings in Python How to print pattern in Python How to check data type in python How to slice a list in python How to implement classifiers in Python How To Print Colored Text in Python How to develop a game in python How to print in same line in python How to create a class in python How to find square root in python How to import numy in python How to import pandas in python How to uninstall python How to upgrade PIP in python How to append a string in python How to open a file in python How to Open a file in python with Path How to run a Python file in CMD How to change the names of Columns in Python How to Concat two Dataframes in Python How to Iterate a List in Python How to learn python Online How to Make an App with Python How to comment out a block of code in Python

Sorting

Python Sort List Sort Dictionary in Python Python sort() function Python Bubble Sort

Programs

Factorial Program in Python Prime Number Program in Python Fibonacci Series Program in Python Leap Year Program in Python Palindrome Program in Python Check Palindrome In Python Calculator Program in Python Armstrong Number Program in Python Python Program to add two numbers Anagram Program in Python Number Pattern Programs in Python Even Odd Program in Python GCD Program in Python Python Exit Program Python Program to check Leap Year Operator Overloading in Python Pointers in Python Python Not Equal Operator Raise Exception in Python Salary of Python Developers in India What is a Script in Python

Python Comment Block

In this tutorial, we will see what comment blocks mean in Python. Further, we will see the commenting methods supported in Python. We will understand the topics deeply with the aid of a few examples.

Through Programming, creativity and the level of thinking of one’s mind get reflected. Good programming is the one that is written in easy-to-understand language, as well as whose debugging can be done quickly. One should be able to reuse it whenever they want in the future. Commenting is a good way of showcasing the thought flow, which can later help understand the intention behind the particular line of code.

Understanding the comment

Commenting is done to make the code more readable, and it helps the third person to understand the code without much difficulty. It would be not easy to understand the code in the future if commenting is not done. Python takes # into account to write the comment.

In other programming languages, including JavaScript, Java, and C++, which consider the following /*... */ for multiline comments, there is no built-in mechanism for multiline comments in Python.

In Python, multiple lines are commented using hash ( # ).

Now, let us understand the meaning and difference between good and bad comments.

Considering the below example of a bad comment (not self-explanatory) -

a = 78             # assigning ‘a’ the value of 78

b = 62             # assigning ‘b’ a value of 62

The following example shows a more descriptive comment which is more beneficial.

gst10 = 1.10            # defining a GST of 10%

gst20 = 1.20            # defining a GST of 20%

 Python offers two ways of commenting –

1. Single line comment – This comment begins with a hash character (#) and is followed by text that contains added explanations.

Let us understand this kind of comment through an example.

Example 1:

# Defining the total marks
Total_marks = 850

Example 2:

# defining the overall structure of the product with default values
product = {
    
}

Example 3:

# it is a comment
print(“bonjour world!”) 

Example 4:

#print("It is a good place to live in")
print("It is a good place to live in!")

Output:

Python Comment Block

Example 4: Comments can be positioned even at the end of a line in the following manner:

print(("It is a good place to live in!")#it is a comment

Output:

Python Comment Block

It is entirely vague for write the comment in a proper text format.

#print(“bonjour world!”)
print(“bonjour world!”)

Output:

Python Comment Block

2. Multiline comments – A python is accomplished in understanding a single line comment and the total comment block. Python does not offer a separate operator; instead, the following methods achieve it.

Through the utility of Multiple Hashtags (#)

In Python, one can consider multiple hashtags (#) to write multiline comments. Here, each line will be regarded as a separate single-line comment.

Example:

# Python program to understand 
# the syntax and working of 
# multiline comments


print("Multiline comments using multiple hashtags")

Output:

Python Comment Block

Using String Literals

One can use string literal as a comment as Python neglects the string literals that are not assigned to a variable so that we can use these string literals as a comment. A single-line comment in Python begins with the hashtag (#) symbol without any white spaces between them and ends at the end of the line.

Example 1: Using a single quote

'This particular line shall be neglected by Python language.'

Explanation: On executing the above code, we won’t receive any output, so a single quote can be used to comment out a statement in Python.

Example 2: Using triple quotes.

""" Python program to demonstrate
multiline comments"""
print("Multiline comments using triple quotes"

Output:

Python Comment Block

Officially, Python doesn't explicitly support multiline comments, so some consider the following options.

Version 1 of Python combines single-line comments.

# LinuxThingy version 1.6.5
#
# Constrains:
#
# -t (--text): display the text interface	
# -h (--help): display this help


Version 2 is moderately simpler than version 1. It is intended to be used for the creation of documentation, but in addition, it can also be used for multiline comments.

“ “ “
LinuxThingy version 1.6.5


Constraints:


-t (--text) : display the text interface
-h (--help) : display this help
“ “ “

It should be noted that the latter version needs to be bounded within special quotation marks (" ") to work instead of hash characters.

Syntax:

# This is a "block comment" or a "multiline" comment in Python, 
# which is constructed 
# out of several
# single-line comments.
# Isn’t it marvellous, yeah?

Example 1:

#This is a comment
#written in 
#more than one line
print(“This is a good place to live in !”) 

Output:

Python Comment Block

Example 2:

"""
This is a comment
written in
more than just one line
"""
 print("Hello, World!")

Output:

Python Comment Block

3. Documentation string

The documentation strings allow associating human-readable documentation with Python modules, functions, classes, and methods. They are not the same as source code comments.

More about them:

A docstring can either be a single-line or multiline comment. In a single-line comment, only one line is used to describe the code, and in the case of multiple lines, more than one line is used.

A docstring begins with an uppercase and ends with a period.      

Now let us understand the documentation string with the aid of an example.

Example:

def addition(a, b, c):
	"""adds the value of a, b and c"""	return a+b+c


# Print the docstring of multiply function
print(addition.__doc__)

Output:

Python Comment Block

Common Practice

It is common to begin a python file with a specific line of comments. These lines prove helpful for the programmer as it contains the description of the project.

Most programming languages, such as C, Java, etc., use syntax for block comments that consist of numerous lines of text.

/*
This is a block comment.
It encompasses multiple lines
of code.
Good, that?
*/

Now, let us see the usage of comments in the actual program.

Example 1: Program to see the calendar of the given month and year.

# Python Program to show the calendar of the given month and year
# importing the calendar module
import calendar
y1 = 2022  # year
m1 = 10    # month
# To take month and year as input from the user
# y1 = int(input("Enter the year: "))
# m1 = int(input("Enter the month: "))


# displaying the calendar
print(calendar.month(y1, m1))

Example 2: Program to find the L.C.M of two numbers entered by the user.

# Python Program to calculate the L.C.M. of two numbers entered by the user


def calculate_lcm(x1, x2):


   # choosing the larger number among the two
   if x1 > x2:
       larger = x1
   else:
       larger = x2


   while(True):
       if((larger % x1 == 0) and (larger % x2 == 0)):
           lcm = larger
           break
       larg
er += 1


   return lcm


num1 = 54
num2 = 24


print("The L.C.M. of the number is", calculate_lcm(num1, num2))

Summary:

In this tutorial, we have learned how to comment in Python. We saw various ways of commenting in Python.

It is not that difficult to write suitable comments in Python. One can easily do it with the power of understanding. Commenting in python is not that complicated, and just the power of endurance is needed. It supports all of us trying to comprehend the code, including the programmer himself, for when they visit their own code again. It becomes more accessible for the user to understand the code with the aid of comments.

We conclude the article with the hope that you understood the comment in python and learned how to use the comment in python.

We hope that the advice we have given you here makes creating better comments and documentation in your code more manageable.



ADVERTISEMENT
ADVERTISEMENT