The Essentials of Java: Static Void Main and Documentation Comments

The static void main Method

The main method is the entry point of any Java application. When you run your program, this is the default method that the Java Virtual Machine (JVM) looks for to start execution.

One of its key features is the String[] args parameter. This allows us to pass command-line arguments (parameters) to the program before it even starts running.

Documentation Comments (Javadoc)

Adding descriptive parameters to your comments is a best practice for clean code. By using specific tags like @param and @return, you create professional documentation.

Example:

Java

/**
 * @param a first operand
 * @param b second operand
 * @return the sum of a and b
 */
static int sum(int a, int b) {
    return a + b;
}

Why Use Javadoc?

The biggest advantage of this commenting style is the hover effect. When you hover your mouse over the method where it is called in your IDE (like IntelliJ or Eclipse), it will display the information you wrote in the comment block. This makes your code much easier to understand for other developers.