Comments in Java

Last Updated: 25 March, 2023

Comments are non-executable statements in Java, the purpose of a comment is to provide information about a set of statements or a single line of statement. It can be also used to comment on Java code if we don't want to execute that piece of code.

Comments are written inside the Java source code file but It is completely ignored by the Java compiler while compiling the code.

Java provides three different types of comments

1. Single-line Comments
2. Multi-line Comments
3. Documentation Comments

Single-line Comments

Single-line Comment is one line of the statement, It starts and ends in the same line.

To write a single-line comment, we can use the // (two forward slashes) symbol. For example,

class Hello { public static void main(String[] args) { // printing Msg "Hello, Welcome to Java Programming World" System.out.println("Hello, Welcome to Java Programming World"); } }

Multi-line Comments

Multi-line comments mean commenting on more than one consecutive line of statements.

We use the /*....*/ symbol for writing multi-line comments. Any statements between /* and */ will be ignored by the Java compiler. For example,

class Hello { public static void main(String[] args) { { /* Java Paper Marks: 60/100 Practical Marks : 15/30 Assignment Marks: 20/30 */ System.out.println("Total Marks: " + 95); }

Java Documentation Comments

Documentation comments are generally used when writing code for a project or software application, since they help generate a documentation page for reference, which can be used to get information about methods present, their parameters, etc.

/** * * There are various types of tags avaiable to depict the parameter * or heading or author name * We can also use HTML tags such as <h1></h1> * */

Javadoc Tags