Comments in Python

Python developers often make use of the comment system as, without the use of it, things can get real confusing, real fast. Comments are the useful information that the developers provide to make the reader understand the source code. It explains the logic or a part of it used in the code. Comments are usually helpful to someone maintaining or enhancing your code when you are no longer around to answer questions about it. These are often cited as a useful programming convention that does not take part in the output of the program but improves the readability of the whole program.

Example:

filter_none

edit
close

play_arrow

link
brightness_4
code

# Python program to demonstrate
# comments
  
  
# sample comment
name ="geeksforgeeks"
print(name) 

chevron_right


Output:

geeksforgeeks

In the above example it can be seen that comments are ignored by the compiler during the execution of the program.

Comments are generally used for the following purposes:



  • Code Readability
  • Explanation of the code or Metadata of the project
  • Prevent execution of code
  • To include resources

Types of comments

There are three main kinds of comments in Python. They are:

  1. Single Line Comments: Python single line comment starts with hashtag symbol with no white spaces (#) and lasts till the end of the line. If the comment exceeds one line then put a hashtag on the next line and continue the comment. Python’s single line comments are proved useful for supplying short explanations for variables, function declarations, and expressions. See the following code snippet demonstrating single line comment:

    Example:

    filter_none

    edit
    close

    play_arrow

    link
    brightness_4
    code

    # This is a comment 
    # Print “GeeksforGeeks !” to console 
    print("GeeksforGeeks"

    chevron_right

    
    

  2. Multi-Line Comments: Python multi-line comment is a piece of text enclosed in a delimiter (""") on each end of the comment. Again there should be no white space between delimiter ("""). They are useful when the comment text does not fit into one line; therefore needs to span across lines. Multi-line comments or paragraphs serve as documentation for others reading your code. See the following code snippet demonstrating multi-line comment:
    filter_none

    edit
    close

    play_arrow

    link
    brightness_4
    code

    """ 
    This would be a multiline comment in Python that 
    spans several lines and describes geeksforgeeks. 
    A Computer Science portal for geeks. It contains  
    well written, well thought  
    and well-explained computer science  
    and programming articles,  
    quizzes and more.  
    … 
    """
    print("GeeksForGeeks"

    chevron_right

    
    

  3. Docstring Comments: Docstring is an in-built feature of Python, which is used to associate documentation that has been written with Python modules, functions, classes and methods. It is added right below the functions, modules or classes to describe what they do. In the Python, the docstring is then made available via the __doc__ attribute.

    Example:

    filter_none

    edit
    close

    play_arrow

    link
    brightness_4
    code

    def multiply(a, b):
        """Multiplies the value of a and b"""
        return a*b
          
          
    # Print the docstring of multiply function
    print(multiply.__doc__)

    chevron_right

    
    

    Output:

    Multiplies the value of a and b
    



My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.


Article Tags :

1


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.