#PYTHON COMMENT HOW TO#

The following is how to use Docstring in your code: Benefits Of Python Comments The doc property in Python makes Docstring available. They are placed just beneath the functions, classes, or modules and indicate their purpose. You can also use three single quotes before and after the part you want to comment on.ĭocstring is a Python built-in feature that is usually connected with documentation. The word was coined by a group of Bell Labs engineers while working on the first touch-tone keypad project. The octothorpe is another name for the symbol (#). Between each para, add an empty line with a hash mark. A comment can be divided into paragraphs. You should start each line with the pound (#) sign, followed by a single space, to add multiline comments. Here’s an example of how to utilize the Python multiline comment. This expanded type of comment can be applied to any or all of the following code. This commenting style can be used to explain anything more elaborate. Multiline or block comments are examples of this type of comment. Python allows you to have comments that span many lines. They’re useful for short explanations and declarations of functions.Īs you can see in the sample above, we placed comments at the beginning and end of the lines to meet our needs. As the name implies, this type of comment can only be one line long. In Python, single-line comments are signified by the hash symbol “ #” and do not contain any white spaces. The hash ( #) symbol is used in Python to denote the beginning of a comment line. Single-line comments are useful for brief, quick comments (or debugging), whereas block comments are frequently used to describe something in greater detail or to block out an entire portion of code. There are two types of comments in Python: single line and multiple line. Python commenting is a little different from other languages, but it’s not too difficult to get used to. Comments act as signposts, making a piece of code self-evident and easy to read.