Search⌘ K
AI Features
Home
Courses
Java Masterclass for Software Developers

Comments

Explore the importance of using comments in Java programs for documenting code, clarifying complex logic, and aiding future debugging. Understand how to write single-line, multi-line, and Javadoc comments to improve code readability and maintenance.

We'll cover the following...

Why use comments

Novice programmers tend to omit comments. But comments provide an opportunity for us to document our thoughts about what our program does and how it solves the problem at hand. Although comments are important to others who read our program, we should realize that they are useful to us, too. Typical programs are written over a period of time. What might be obvious to you today could be baffling next week.

See the program given below:

Java
// Sample.java by F. M. Carrano
// Displays strings and provides an example of a Java application.
public class Sample
{
   public static void main(String[] args)
   {
      // Demonstrate println
      System.out.println("This string is displayed on one line.");
      System.out.println("This string appears on the second line.");
      System.out.println(); // The third line displayed is blank
      // Demonstrate print
      System.out.print("Four ");
      System.out.print("and twenty ");
      System.out.println("blackbirds");
      System.out.println("Baked in a pie.");
   } // End main
} // End Sample

Single-line comments

The program given above showed one kind of Java comment: a line that begins with two slashes. We use this form of comments within ...