Understanding Java Comments: Types and Examples

What are Java Comments? An example

Java comments are annotations in the code that are ignored by the Java compiler. They are used to provide explanations, notes, or documentation within the code, making it easier for developers to understand the code's purpose and functionality. Comments can also be used to temporarily disable code during debugging.

There are three types of comments in Java:

1. Single-line comments: These comments start with // and continue to the end of the line.

   // This is a single-line comment
   int x = 5; // This is also a single-line comment
   

2. Multi-line comments: These comments start with /* and end with */. They can span multiple lines.

   /* This is a multi-line comment
      that spans multiple lines */
   int y = 10;
   

3. Documentation comments: These comments start with /** and end with */. They are used to generate documentation using tools like Javadoc.

   /**
    * This method adds two integers.
    * @param a the first integer
    * @param b the second integer
    * @return the sum of a and b
    */
   public int add(int a, int b) {
       return a + b;
   }
   

Example of Java Comments in Code

public class Example {
    public static void main(String[] args) {
        // This is the main method
        int a = 5; // Initialize variable a
        int b = 10; // Initialize variable b

        // Call the add method and store the result
        int sum = add(a, b);
        System.out.println("The sum is: " + sum);
    }

    /**
     * This method adds two integers.
     * @param a the first integer
     * @param b the second integer
     * @return the sum of a and b
     */
    public static int add(int a, int b) {
        return a + b; // Return the sum
    }
}

In this example, comments are used to explain the purpose of the main method, the initialization of variables, and the functionality of the add method.