• Java
    • JAXB Tutorial
      • What is JAXB
      • JAXB Marshalling Example
      • JAXB UnMarshalling Example
  • Spring Tutorial
    • Spring Core Tutorial
    • Spring MVC Tutorial
      • Quick Start
        • Flow Diagram
        • Hello World Example
        • Form Handling Example
      • Handler Mapping
        • BeanNameUrlHandlerMapping
        • ControllerClassNameHandlerMapping
        • SimpleUrlHandlerMapping
      • Validation & Exception Handling
        • Validation+Annotations
        • Validation+ResourceBundle
        • @ExceptionHandler
        • @ControllerAdvice
        • Custom Exception Handling
      • Form Tag Library
        • Textbox Example
        • TextArea Example
        • Password Example
        • Dropdown Box Example
        • Checkboxes Example
        • Radiobuttons Example
        • HiddenValue Example
      • Misc
        • Change Config file name
    • Spring Boot Tutorial
  • Hibernate Tutorial
  • REST Tutorial
    • JAX-RS REST @PathParam Example
    • JAX-RS REST @QueryParam Example
    • JAX-RS REST @DefaultValue Example
    • JAX-RS REST @Context Example
    • JAX-RS REST @MatrixParam Example
    • JAX-RS REST @FormParam Example
    • JAX-RS REST @Produces Example
    • JAX-RS REST @Consumes Example
    • JAX-RS REST @Produces both XML and JSON Example
    • JAX-RS REST @Consumes both XML and JSON Example
  • Miscellaneous
    • JSON Parser
      • Read a JSON file
      • Write JSON object to File
      • Read / Write JSON using GSON
      • Java Object to JSON using JAXB
    • CSV Parser
      • Read / Write CSV file
      • Read/Parse/Write CSV File – OpenCSV
      • Export data into a CSV File
      • CsvToBean and BeanToCsv – OpenCSV

JavaInterviewPoint

Java Development Tutorials

Python Comments – Single Line and Multi Line Comments

June 22, 2020 by javainterviewpoint Leave a Comment

Comments are a handy tool for programmers and considered as one of the best practices for developers. Even though comments will not alter the execution flow or change the outcome of the code, it improves the readability of the code and helps you to understand why a particular block of code was written at a later point. In this article, we will learn about Python Comments, both Single line, and Multi-line comments.

Why Are Comments Needed?

We know that Comments will not alter the execution flow or change the outcome of the code, but why is it needed?

As the program gets bigger and more complicated, they get more challenging to read, and it is often difficult to look at a piece of code and figure out what it is doing, or why. For this reason, add comments to your program to explain in natural language what the program is doing.

They come in handy when someone else is analyzing your code for a bug fix or implement a new logic, just by reading your comments they should be able to understand your code better rather than going through the entire code.

Comments serve the below two purposes.

  • It explains how the program works, which helps others to understand the sole purpose of your code.
  • It allows you to temporarily skip certain parts of the program so you can test other parts of the program.

Comments are non-executable statements, neither the Python compiler nor the PVM will execute them.

Python Comments

Python Comments 1
There are two types of comments in Python:

  1. Single line comments
  2. Multiline comments, 0r Block comments

Single line comments

This comment starts with a hash symbol (#), this mentions the compiler they should treat the entire following line as comments

For Example,

# Initializing the message
 message = 'Welcome to JavaInterviewPoint'

Here the first line is starting with a #, and hence the whole block gets treated as a comment.

You can also add comments inside a code, like below.

a = 15 # Store value 15 into variable a

Here, comments appear after the statement a =15, # symbol defines the start of the comment describing “Store value 15 into variable a”

Multiline comments (or) Block comments

Multiline comments are useful to explain complex codes,

When we need to mark multiple lines as comments, then adding # at the beginning of each line be a tremendous job.

For Example,

# This is a program reads the input from the user 
# and performs the addition operation on the input values

Instead of starting every line with the # symbol, we can write the previous block of code, we can write the previous block of code inside “”” (triple-double quotes) or ”’ (triple single quotes) in the beginning and end of the block as below

"""
This is a program reads the input from the user 
and performs the addition operation on the input values
"""

or

'''
This is a program reads the input from the user 
and performs the addition operation on the input values
'''

The triple-double quotes (“””) or triple single quotes (”’) are called as ‘multi-line comments’ or ‘block comments’.

If we write the block comments as first statements in a module, function, class, or a method, then these strings are called documentation strings or docstrings. These docstrings are useful to create an API documentation file from a Python program.

Note:

Unlike other programming languages, Python by default will not support Multiline comments and the recommended approach to comment out multiple lines of code in Python is to use consecutive # single-line comments

Filed Under: Python Tagged With: Block Comments, Multi Line Comments, Python Comments, Single Line Comments

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Java Basics

  • JVM Architecture
  • Object in Java
  • Class in Java
  • How to Set Classpath for Java in Windows
  • Components of JDK
  • Decompiling a class file
  • Use of Class.forName in java
  • Use Class.forName in SQL JDBC

Oops Concepts

  • Inheritance in Java
  • Types of Inheritance in Java
  • Single Inheritance in Java
  • Multiple Inheritance in Java
  • Multilevel Inheritance in Java
  • Hierarchical Inheritance in Java
  • Hybrid Inheritance in Java
  • Polymorphism in Java – Method Overloading and Overriding
  • Types of Polymorphism in java
  • Method Overriding in Java
  • Can we Overload static methods in Java
  • Can we Override static methods in Java
  • Java Constructor Overloading
  • Java Method Overloading Example
  • Encapsulation in Java with Example
  • Constructor in Java
  • Constructor in an Interface?
  • Parameterized Constructor in Java
  • Constructor Chaining with example
  • What is the use of a Private Constructors in Java
  • Interface in Java
  • What is Marker Interface
  • Abstract Class in Java

Java Keywords

  • Java this keyword
  • Java super keyword
  • Final Keyword in Java
  • static Keyword in Java
  • Static Import
  • Transient Keyword

Miscellaneous

  • newInstance() method
  • How does Hashmap works internally in Java
  • Java Ternary operator
  • How System.out.println() really work?
  • Autoboxing and Unboxing Examples
  • Serialization and Deserialization in Java with Example
  • Generate SerialVersionUID in Java
  • How to make a class Immutable in Java
  • Differences betwen HashMap and Hashtable
  • Difference between Enumeration and Iterator ?
  • Difference between fail-fast and fail-safe Iterator
  • Difference Between Interface and Abstract Class in Java
  • Difference between equals() and ==
  • Sort Objects in a ArrayList using Java Comparable Interface
  • Sort Objects in a ArrayList using Java Comparator

Follow

  • Coding Utils

Useful Links

  • Spring 4.1.x Documentation
  • Spring 3.2.x Documentation
  • Spring 2.5.x Documentation
  • Java 6 API
  • Java 7 API
  • Java 8 API
  • Java EE 5 Tutorial
  • Java EE 6 Tutorial
  • Java EE 7 Tutorial
  • Maven Repository
  • Hibernate ORM

About JavaInterviewPoint

javainterviewpoint.com is a tech blog dedicated to all Java/J2EE developers and Web Developers. We publish useful tutorials on Java, J2EE and all latest frameworks.

All examples and tutorials posted here are very well tested in our development environment.

Connect with us on Facebook | Privacy Policy | Sitemap

Copyright ©2023 · Java Interview Point - All Rights Are Reserved ·