How to write comments in python

In Eclipse + PyDev, Python block commenting is similar to Eclipse Java block commenting; select the lines you want to comment and use Ctrl + / to comment. To uncomment a commented block, do the same thing. The only mechanism to comment out Python code (understood as code ignored by the interpreter) is the #.

Python Comments Example

Single line comment, multi-line comment and the comment that is starting in the same line after the code.

Comments are non-executable statements in Python. It means neither the python compiler nor the PVM will execute them. Comments are intended for human understanding, not for the compiler or PVM. There are two types of commenting features available in Python: These are single-line comments and multi-line comments.

A comment is text in a program’s code, script, or another file that is not meant to be seen by the user running the program. However, is seen when viewing the source code. Comments help make code easier to understand by explaining what is happening and help prevent portions of a program from executing.

Comment Syntax

Comments in Python begin with a hash mark ( # ) and whitespace character and continue to the end of the line. Because comments do not execute, when you run a program you will not see any indication of the comment there. Comments are in the source code for humans to read, not for computers to execute.

(Entry 1 of 2) 1 : commentary. 2 : a note explaining, illustrating, or criticizing the meaning of a writing Comments on the passage were printed in the margin. 3a : an observation or remark expressing an opinion or attitude critical comments constructive comments.

The single line comment is //. Everything from the // to the end of the line is a comment. To mark an entire region as a comment, use /* to start the comment and */ to end the comment.

Unlike other programming languages Python doesn’t support multi-line comment blocks out of the box. The recommended way to comment out multiple lines of code in Python is to use consecutive # single-line comments. This is the only way to get “true” source code comments that are removed by the Python parser.

A comment in Python starts with the hash character, # , and extends to the end of the physical line. A hash character within a string value is not seen as a comment, though. To be precise, a comment can be written in three ways – entirely on its own line, next to a statement of code, and as a multi-line comment block.

Multiline comments are used for large text descriptions of code or to comment out chunks of code while debugging applications. Comments are ignored by the compiler.

To comment out multiple code lines right-click and select Source > Add Block Comment. ( CTRL+SHIFT+/ )

The keyboard shortcut to comment multiple in Windows is shift + alt + A .

The shortcut to comment out multiple lines of code in spyder IDE is to first select all the lines which need to be commented out and then the key combination ctrl+4 is pressed. This turns the entire selected lines into a python comment as shown below.

Short-key for commenting using IDLE

If you are using the IDLE editor for developing Python programs, you may use the short-keys or menu options. For commenting a line, bring the cursor to the line that you want to comment and press Alt+4. To uncomment an existing comment, press Alt+3.

The shortcut key for for commenting and uncommenting in Spyder is Ctrl + 1 (Click Ctrl and 1 simultaneously).

A comment in Python starts with the hash character, # , and extends to the end of the physical line. A hash character within a string value is not seen as a comment, though. To be precise, a comment can be written in three ways – entirely on its own line, next to a statement of code, and as a multi-line comment block.

In Python, there are two ways to annotate your code. The first is to include comments that detail or indicate what a section of code – or snippet – does. The second makes use of multi-line comments or paragraphs that serve as documentation for others reading your code.

Python block comments

A block comment explains the code that follows it. Typically, you indent a block comment at the same level as the code block. To create a block comment, you start with a single hash sign ( # ) followed by a single space and a text string.