Right Way to Write Comments

Comments serve the main purpose to explain your code. Developers use healthy comment writing practice for better understanding of the code.

Some of the tips you can follow, to make your comments effective are:

  1. Comments should be short and precise.
  2. Use comments only when necessary, don’t clutter your code with comments.
  3. Comment should have some meaning.
  4. Avoid writing generic or basic comments.
  5. Write comments that are self explanatory.

We have discussed all about Python comments, how to write Python comments, types of comment,what are it’s advantages and the right way to write comments.



Python Comments: Importance, Types and Correct Way to Use

Comments in Python are the lines in the code that are ignored by the interpreter during the execution of the program.




# I am single line comment
  
  
""" Multi-line comment used
print("Python Comments") """


Comments enhance the readability of the code and help the programmers to understand the code very carefully. It also helps in collaborating with other developers as adding comments makes it easier to explain the code.

Similar Reads

Types of Comments in Python

There are three types of comments in Python:...

Comments in Python

In the example, it can be seen that Python Comments are ignored by the interpreter during the execution of the program....

Why are Comments Used in Python?

...

Types of Comments in Python

Comments have been an integral part of programming languages, and every language have different ways of using comments....

Advantages of Comments in Python

Let’s discover the different types of comments, how to use them and when to use them?...

Right Way to Write Comments

...