Comments In Python
 

Comments In Python

 

The comments in a programming language are used to explain something in the source code. For example, it can be used to explain what a line of code or block of code is doing.

It enhances the readability of code that means if a source code is given to someone else for modification, he can easily understand things if explained with the help of comments. Each programming language uses a different syntax for comments.

Why comments are used?

A comment in a source code can be used to –

  • Explain what a line or block of code if doing
  • Enhance the readability of source code
  • Comments are ignored by compilers or interpreters. So it can be used to prevent the execution while testing the code
  • Comments are processed in various ways to generate documentation by using a document generator

Comments in Python

For writing comments in Python code, you need to use # at the starting of a line. Python interpreter ignores the lines that are starting with # symbol.

Single line comment

Put a # symbol before writing your comment.

For example –

#This is a single line comment

print ("Hello World!")

Multi-line comment

Python doesn’t have a different way of writing multiline comments, you need to use # at the starting of each line.

#This is a multi-line
#comment in Python

print("Hello World!")

Best practices while using comments in Python

  • Write short and concise comments that explain the code
  • Write clean and self-explanatory code so you need not explain so many things of source code using comments
  • Try to identify and remove all the comments that are redundant

You have learned how to use comments in the Python programming language. Now you can put your thoughts in the comments below.

Previous Writing Hello World! Program In Python
Next Variables and Constants In Python
 

About author

You might also like

Python Programming 0 Comments

Python filter() function

The filter function in Python filters the elements from a sequence or iterable with the use of a function that is passed as an argument to filter function. It tests

Programming 0 Comments

Introduction to Python functions

This post was last updated on March 6th, 2021 at 08:20 amA Python function is a self-contained module of code that performs a specific task. It takes inputs, processes them,

Python Programming 0 Comments

Python Set Comprehension

A Python set is an unordered collection of unique items that is iterable, mutable, and has no duplicate items. You can perform mathematical set operations such as union, intersection, set

0 Comments

No Comments Yet!

You can be first to comment this post!

Leave a Reply