How to comment out multiple lines in Python

Python has many ways in which to comment on multiple lines of Python. One possibility is to feature # at the beginning of every line. ginger eight and therefore the larger a part of the community opt to comment out like:

# this can be a comment

# with multiple lines

instead of:

“””

This is a comment

with multiple lines

“””

Multiline comments in Python will begin with ”’ and finish with ”’. Multiline comment is made just by putting them within triple-quoted strings:”’/””” and ”’/”””.

Both examples have valid syntax in Python.

How to comment out multiple lines in Python 

In Python, there’s a special image for comments that is #. Some languages, such as Java, have local support for multi-line comments.

Python multiline comment would seem like to:

# This

# is a

# multi-line

# comment

This is the default comment for many standard Python days like PyCharm, Sublime, VS Code.

Python multiline comments and docstrings

Guido van Rosem (creator of Python, Python BDFL) once posted a “Pro-Tip” of Python comments in multi-lines:

@BSUCSClub Python tip: you’ll be able to use multi-line strings as multi-line comments. Unless used as docstring, they do not generate any code! 🙂

According to this tip, you’ll be able to do comments during this way:

“””line1

line2

line3″””

”’line1

line2

line3”’

What is a docstring? the primary statement in a very category, method, function, or module definition that may be a string is termed a docstring. Example:

def is_palindrome(word):

    “””Check if the word is a palindrome.”””

    str(word) == str(word)[::-1]

Note 1: even though a docstring contains only 1 line, triple quotes ought to be used as a result of it’s easier to expand it within the future.

Note 2: For one-liners, it’s suggested the quotes get on constant line because of the comment.

Multiline docstrings example

Descriptive multiline docstrings facilitate understanding and maintaining the code. Here you’ll be able to realize AN example for such:

def complex(real=0.0, imag=0.0):

    “””Form a complex number.

    Keyword arguments:

    real — the real part (default 0.0)

    imag — the imaginary part (default 0.0)

    “””

    if imag == 0.0 and real == 0.0:

        return complex_zero

    …

Many and organizations are exploiting this type of comment when they want to get good documentation.

Multi-line shortcuts for Python and IDEs are very popular

For commenting many lines on a preferred day you’ll be able to use consequent shortcuts.

First, you would like to pick the lines then press:

  • Pycharm – CTRL + / – comment / uncomment
  • Eclipse – CTRL + /- comment / uncomment
  • Sublime – CTRL + /- comment / uncomment
  • Atom – CTRL + /- comment / uncomment
  • IDLE – CTRL + ALT + 3 – comment, CTRL + ALT + 4 – uncomment
  • Notepad++ – CTRL + Q – comment / uncomment
  • vim – CTRL + Q / kbd>CTRL + V – comment / uncomment
  • VS Code – CTRL + / – comment / uncomment

Note: If you wish to feature a multi-line docstring then you’ll be able to use completely different combinations:

  • Pycharm – Alt + Enter  function and select Insert text string stack 
  • VS Code – Alt + Shift + A – comment / uncomment

PyCharm comment multiple lines 

Pycharm comment shortcut

Here are the shortcuts to commenting on the various lines in Python and Pie Charm:

  • Windows or Linux: Ctrl + /
  • Mac OS: Command + /

Pycharm comment out multiple lines

To touch upon many lines of code within the Pycharm follow consequent steps:

  • Select the code lines
  • Menu
  • Code
  • Comment with Line Comment
    • Windows or Linux: Ctrl + /
    • Mac OS: Command + /

result:

# time.sleep(50 / 1000)           # 50 ms

# time.sleep(5)                   # 5 secs

# time.sleep(60)                  # 1 min

Pycharm uncomment multiple lines

To uncomment commented lines in PyCharm you’ll be able to roll in the hay by constant steps as commenting:

  • Select the code lines
  • Menu
  • Code
  • Comment with Line Comment
    • Windows or Linux: Ctrl + /
    • Mac OS: Command + /

time.sleep(50 / 1000)           # 50 ms

time.sleep(5)                   # 5 secs

time.sleep(60)                  # 1 min

Note: If you are attempting to comment mixed lines code and comments then

  • first press Ctrl + / will comment all lines (add second mark # # in front of commented lines)
  • the second Ctrl + / will uncomment  all lines (only the first comment)

Before

# time.sleep(50 / 1000)           # 50 ms

# time.sleep(5)                   # 5 secs

time.sleep(60)                  # 1 min

time.sleep(60 * 60)             # 1 hour

After

# time.sleep(50 / 1000)           # 50 ms

# # time.sleep(5)                   # 5 secs

# time.sleep(60)                  # 1 min

# time.sleep(60 * 60)             # 1 hour

Python takes away all comments from a project with regex finders

You can remove all Python comments from your Python (Pycharm) project:

  • open replace Ctrl + R
  • check regex
  • use
    • single-line comment

.*#.*\n

* docstring line comment

“””.*”””

* docstring with new lines inside

([^\(\.]”””[^\(]*)”””

  • replace all with nothing

Demonstration:

remove Python multiline comment.

Finally, you’ll be able to watch the video for Python comments in PyCharm:

How to remove all Python (Java) comments in PyCharm / IntelliJ.

References

Leave a Reply

Your email address will not be published.

Ads Blocker Image Powered by Code Help Pro

Ads Blocker Detected!!!

We have detected that you are using extensions to block ads. Please support us by disabling these ads blocker.

Powered By
Best Wordpress Adblock Detecting Plugin | CHP Adblock