How To Write Comments in Python 3

Comments are lines in your code that are ignored by the Python interpreter. They are useful for adding notes or explanations to your code. In Python, you can write comments using the # symbol.

Single-line Comments

The most common way to write a comment in Python is to use the # symbol at the beginning of a line.

      
        # This is a comment
        print("Hello, world!") # This is another comment
      
    

Multi-line Comments

If you need to write a comment that spans multiple lines, you can use triple quotes (""") to create a multi-line string literal. Since the string literal is not assigned to a variable, it is effectively a comment.

      
        """
        This is a multi-line
        comment in Python.
        """
        print("Hello, world!")
      
    

Documentation Strings

Python has a special type of comment called a "documentation string" or "docstring" for short. A docstring is a string literal that appears as the first statement in a module, function, class, or method definition. Docstrings are used to provide documentation for your code, and can be accessed using the built-in help() function.

      
        def my_function():
            """
            This is a docstring. It provides documentation
            for the function and can be accessed using the help() function.
            """
            print("Hello, world!")

        help(my_function)
      
    

Conclusion

Comments are an essential part of any programming language, and Python makes it easy to add comments to your code. By using the # symbol or triple quotes, you can write single-line or multi-line comments, and by using docstrings, you can provide documentation for your code.

Keywords: Python, comments, syntax, single-line comments, multi-line comments, triple quotes, documentation strings, docstring, help() function, programming.