{"id":12519,"date":"2018-04-06T09:58:19","date_gmt":"2018-04-06T09:58:19","guid":{"rendered":"https:\/\/data-flair.training\/blogs\/?p=12519"},"modified":"2026-05-16T17:47:55","modified_gmt":"2026-05-16T12:17:55","slug":"java-comments","status":"publish","type":"post","link":"https:\/\/data-flair.training\/blogs\/java-comments\/","title":{"rendered":"3 Types of Comments in Java – Why comments are Important?"},"content":{"rendered":"

Java Comments<\/strong> are used in programs to make the code more understandable.<\/em> Therefore, comments in Java (remarks) make a program more intelligible as they set out the details of the code. However, appropriate utilization of remarks also makes support simpler and helps discover bugs effectively. The compiler disregards the comment while aggregating code, i.e., the compiler won\u2019t read them because these statements are non-executable.<\/p>\n

However, we are going to discuss different types of Java comments with their syntax and examples. Last but not least, we will cover the complete table of comments used in Java.<\/p>\n

Let’s take the driving seat and speed up your programming skills.<\/p>\n

To master the concept of comments, you should know the Basic Java Syntax<\/a>.<\/strong><\/em><\/p>\n

Types of Comments in Java<\/h3>\n

There are three types of Java comments:<\/p>\n

Single-line Comments in Java<\/h4>\n

These are used when the comment written is short or a one-liner. Therefore, the single-line comment in Java is denoted by using two forward slashes before a statement.<\/p>\n

Syntax of single-line comments in Java<\/strong><\/p>\n

\/\/ A comment is written here<\/pre>\n
Example of Java single-line comment:<\/strong><\/p>\n
class Scomment\r\n{\r\n\u00a0\u00a0\u00a0 public static void main(String args[])\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Single line comment here\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 System.out.println(\"Single line comment above\");\r\n\u00a0\u00a0\u00a0 }\r\n}<\/pre>\n
Multi-line Comments in Java<\/h4>\n
Whenever we need to explain a procedure, we use Java multiline comments. Whereas single-line comments become tedious in this case, as we will need to write \u2018\/\/\u2019 at the start of every line, therefore we use multiline comments in Java.<\/p>\n
Syntax of multi-line comment in Java-<\/strong><\/p>\n
\/*Comment starts\r\ncontinues\r\ncontinues\r\n.\r\n.\r\n.\r\nComment ends*\/<\/pre>\n
Let’s take a break and learn <\/strong><\/em>Classes and Objects in Java<\/strong><\/em><\/a>.<\/p>\n
Example of multi-line comment in Java:<\/strong><\/p>\n
class Scomment\r\n{\r\n\u00a0\u00a0\u00a0 public static void main(String args[])\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 System.out.println(\"Multi line comments below\");\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/*Comment line 1\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Comment line 2\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Comment line 3*\/\r\n\u00a0\u00a0\u00a0 }\r\n}<\/pre>\n
Documentation Comments in Java<\/h4>\n
Although this kind of Java comment is utilized by large code for a programming bundle since it produces a documentation page for reference, which can be utilized for getting data about strategies, their parameters, and so forth.<\/p>\n
Syntax of Java documentation comments –<\/strong><\/p>\n
\/**Comment start\r\n*\r\n*tags are used in order to specify a parameter\r\n*or method or heading\r\n*HTML tags can also be used\r\n*such as <h1>\r\n*\r\n*comment ends*\/<\/pre>\n
Example of documentation comment in Java<\/strong>\u00a0<\/strong>\u2013<\/strong><\/p>\n
package JavaCommentsDemo;\r\n\/\/Program to illustrate comments in Java\r\n\/**\r\n* <h1>Find sum of two numbers!<\/h1>\r\n* FindSum program finds the sum\r\n*and gives the output on\r\n*the screen.\r\n*\r\n* @author  dataflair\r\n*\/\r\npublic class FindSum \r\n{\r\n\t\/**\r\n\t    * Method to find average\r\n\t    * @param numA- This is the first parameter to calculateSum method\r\n\t    * @param numB - This is the second parameter to calculateSum method\r\n\t    *\/\r\n\tint numA;\r\n\tint numB;\r\nFindSum(int numA,int numB)\r\n{\r\n\tthis.numA=numA;\r\n\tthis.numB=numB;\r\n}\r\nvoid calculateSum()\r\n{\r\n\tSystem.out.println(\"Sum of two numbers is \"+(numA+numB));\r\n}\r\nstatic class Test\r\n{\r\n\tpublic static void main(String args[])\r\n\t{\r\n\t\tFindSum obj=new FindSum(10,20);\r\n\t\tobj.calculateSum();\r\n\t}\r\n}\r\n}<\/pre>\n
Recommended Reading –\u00a0Primitive & Non-Primitive Data types with Examples<\/a><\/strong><\/em><\/p>\n
Output-<\/strong><\/p>\n
\"FindSum\"<\/a><\/p>\n
Benefits of Using Comments in Java<\/h3>\n
However, there are several advantages of using comments in your Java code:<\/p>\n
1. Enhanced Code Readability:<\/strong> Comments act as explanatory notes, making your code easier to understand for yourself and others. Therefore, well-placed comments can clarify complex logic, the purpose of variables and methods, and the overall program flow. However, this is especially beneficial when revisiting your code after some time or collaborating with other programmers.<\/p>\n
2. Improved Maintainability:<\/strong> Comments can significantly simplify code maintenance. Wherever Codebases evolve, modifications become more manageable when the code is well-commented. Hence, Comments explain the reasoning behind specific code sections, making it easier for developers to understand the intent and adjust the code as needed.<\/p>\n
3. Efficient Debugging:<\/strong> Also, comments can aid in debugging by providing clues about the expected behavior of different code sections. However, when an error arises, tracing the code’s execution with the help of comments can streamline the troubleshooting process. Therefore, comments can also indicate potential issues or areas for improvement.<\/p>\n
4. Future Updation:<\/strong> Adding a comment to your code simplifies making the changes. Therefore, it helps to switch to the particular part of the program rather than understanding the whole code. Hence, For future use it becomes easier for other programmers to understand the program and make updates.<\/p>\n
Table of Java Comments<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Tag<\/strong><\/td>\nDescription<\/strong><\/td>\nSyntax<\/strong><\/td>\n<\/tr>\n
@serialField<\/td>\nUsed to document an ObjectStreamField component<\/td>\n@serialField field-name field-type field-description<\/td>\n<\/tr>\n
@since<\/td>\nAdds a \u201cSince\u201d heading to the generated document.<\/td>\n@since release<\/td>\n<\/tr>\n
@throws<\/td>\nSynonym to @since<\/td>\n@throws class-name description<\/td>\n<\/tr>\n
{@value}<\/td>\nWhen {@value} is used in the comment of the document of a static field, it displays the value of that constant.<\/td>\n{@value package.class#field}<\/td>\n<\/tr>\n
@version<\/td>\nThis method<\/a> adds a \u201cVersion\u201d subheading along with the specified version-text to the generated docs when the -version option is used.<\/td>\n@version version-text<\/td>\n<\/tr>\n
{@link}<\/td>\nThis method inserts an in-line link with the visible text label that points to the documentation for the specified package, class, or member name of a referenced class.<\/td>\n{@link package.class#member label}<\/td>\n<\/tr>\n
{@linkplain}<\/td>\nIdentical to {@link}, except the link\u2019s label is displayed in plain text than code font.<\/td>\n{@linkplain package.class#member label}<\/td>\n<\/tr>\n
@param<\/td>\nAdds a parameter with the specified parameter-name followed by the specified description to the \u201cParameters\u201d section.<\/td>\n@param parameter-name description<\/td>\n<\/tr>\n
@return<\/td>\nThis method adds a \u201cReturns\u201d section with the description text.<\/td>\n@return description<\/td>\n<\/tr>\n
@see<\/td>\nThis method adds a \u201cSee Also\u201d heading with a link or text entry that points to reference.<\/td>\n@see reference<\/td>\n<\/tr>\n
@serial<\/td>\nThis method is used in the document comment for a default serializable field.<\/td>\n@serial field-description | include | exclude<\/td>\n<\/tr>\n
@serialData<\/td>\nThis method documents the data written by the writeObject( ) or writeExternal( ) methods.<\/td>\n@serialData data-description<\/td>\n<\/tr>\n
@author<\/td>\nIt is used to add the author of a class.<\/td>\n@author name-text<\/td>\n<\/tr>\n
{@code}<\/td>\nIt displays text in code font without interpreting the text as HTML markup or nested javadoc tags.<\/td>\n{@code text}<\/td>\n<\/tr>\n
{@docRoot}<\/td>\nThis method is used to represent the path relative to the generated root directory page<\/td>\n{@docRoot}<\/td>\n<\/tr>\n
@deprecated<\/td>\nThis method adds a comment indicating that this API should be discontinued<\/td>\n@deprecated deprecatedtext<\/td>\n<\/tr>\n
@exception<\/td>\nIt adds a\u00a0Throws\u00a0subheading to the generated documentation, with the classname and description text.<\/td>\n@exception class-name description<\/td>\n<\/tr>\n
{@inheritDoc}<\/td>\nUsed to inherit the comment from the implementable interface or the nearest inheritable class.<\/td>\nInherits a comment from the immediate surperclass.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Summary<\/h3>\n
As a result, Comments in Java are used to provide some extra information about the code. Single-line, multi-line, and documentation are the three ways to present the comments in Java. Although these are optional, the programmer is not bound to use them. Hence, the remarks are only for providing a better understanding of the code.<\/p>\n
Now, it’s the right time to discuss Variables in Java\u00a0<\/a><\/strong><\/em><\/p>\n
Hope you like the explanation. Please share your experience in our comment section.
Java Comments are used in programs to make the code more understandable. Therefore, comments in Java (remarks) make a program more intelligible as they set out the details of the code. However, appropriate utilization...<\/p>\n","protected":false},"author":5,"featured_media":64101,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[32],"tags":[4291,20657,20659,20658],"class_list":["post-12519","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-java","tag-example-of-java-comments","tag-java-documentation-comments","tag-java-multi-line-comments","tag-java-single-line-comments"],"yoast_head":"\n3 Types of Comments in Java - Why comments are Important? - DataFlair<\/title>\n<meta name=\"description\" content=\"Java comments are non-executable statements, used to understand Code better. Learn different types of Java comments Single, multi-line, documentation\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/data-flair.training\/blogs\/java-comments\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"3 Types of Comments in Java - Why comments are Important? - DataFlair\" \/>\n<meta property=\"og:description\" content=\"Java comments are non-executable statements, used to understand Code better. Learn different types of Java comments Single, multi-line, documentation\" \/>\n<meta property=\"og:url\" content=\"https:\/\/data-flair.training\/blogs\/java-comments\/\" \/>\n<meta property=\"og:site_name\" content=\"DataFlair\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/DataFlairWS\/\" \/>\n<meta property=\"article:published_time\" content=\"2018-04-06T09:58:19+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-05-16T12:17:55+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/04\/Types-of-comments-in-Java.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"802\" \/>\n\t<meta property=\"og:image:height\" content=\"420\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"DataFlair Team\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@DataFlairWS\" \/>\n<meta name=\"twitter:site\" content=\"@DataFlairWS\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"DataFlair Team\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"3 Types of Comments in Java - Why comments are Important? - DataFlair","description":"Java comments are non-executable statements, used to understand Code better. Learn different types of Java comments Single, multi-line, documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/data-flair.training\/blogs\/java-comments\/","og_locale":"en_US","og_type":"article","og_title":"3 Types of Comments in Java - Why comments are Important? - DataFlair","og_description":"Java comments are non-executable statements, used to understand Code better. Learn different types of Java comments Single, multi-line, documentation","og_url":"https:\/\/data-flair.training\/blogs\/java-comments\/","og_site_name":"DataFlair","article_publisher":"https:\/\/www.facebook.com\/DataFlairWS\/","article_published_time":"2018-04-06T09:58:19+00:00","article_modified_time":"2026-05-16T12:17:55+00:00","og_image":[{"width":802,"height":420,"url":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/04\/Types-of-comments-in-Java.jpg","type":"image\/jpeg"}],"author":"DataFlair Team","twitter_card":"summary_large_image","twitter_creator":"@DataFlairWS","twitter_site":"@DataFlairWS","twitter_misc":{"Written by":"DataFlair Team","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/data-flair.training\/blogs\/java-comments\/#article","isPartOf":{"@id":"https:\/\/data-flair.training\/blogs\/java-comments\/"},"author":{"name":"DataFlair Team","@id":"https:\/\/data-flair.training\/blogs\/#\/schema\/person\/7f83c342f5d1632d6f7b4b0b0f447823"},"headline":"3 Types of Comments in Java – Why comments are Important?","datePublished":"2018-04-06T09:58:19+00:00","dateModified":"2026-05-16T12:17:55+00:00","mainEntityOfPage":{"@id":"https:\/\/data-flair.training\/blogs\/java-comments\/"},"wordCount":944,"commentCount":13,"publisher":{"@id":"https:\/\/data-flair.training\/blogs\/#organization"},"image":{"@id":"https:\/\/data-flair.training\/blogs\/java-comments\/#primaryimage"},"thumbnailUrl":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/04\/Types-of-comments-in-Java.jpg","keywords":["example of Java Comments","Java Documentation Comments","Java Multi-line Comments","Java Single line Comments"],"articleSection":["Java Tutorials"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/data-flair.training\/blogs\/java-comments\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/data-flair.training\/blogs\/java-comments\/","url":"https:\/\/data-flair.training\/blogs\/java-comments\/","name":"3 Types of Comments in Java - Why comments are Important? - DataFlair","isPartOf":{"@id":"https:\/\/data-flair.training\/blogs\/#website"},"primaryImageOfPage":{"@id":"https:\/\/data-flair.training\/blogs\/java-comments\/#primaryimage"},"image":{"@id":"https:\/\/data-flair.training\/blogs\/java-comments\/#primaryimage"},"thumbnailUrl":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/04\/Types-of-comments-in-Java.jpg","datePublished":"2018-04-06T09:58:19+00:00","dateModified":"2026-05-16T12:17:55+00:00","description":"Java comments are non-executable statements, used to understand Code better. Learn different types of Java comments Single, multi-line, documentation","breadcrumb":{"@id":"https:\/\/data-flair.training\/blogs\/java-comments\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/data-flair.training\/blogs\/java-comments\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/data-flair.training\/blogs\/java-comments\/#primaryimage","url":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/04\/Types-of-comments-in-Java.jpg","contentUrl":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/04\/Types-of-comments-in-Java.jpg","width":802,"height":420,"caption":"Types of Comments in Java"},{"@type":"BreadcrumbList","@id":"https:\/\/data-flair.training\/blogs\/java-comments\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Blog Home","item":"https:\/\/data-flair.training\/blogs\/"},{"@type":"ListItem","position":2,"name":"Java Tutorials","item":"https:\/\/data-flair.training\/blogs\/category\/java\/"},{"@type":"ListItem","position":3,"name":"3 Types of Comments in Java – Why comments are Important?"}]},{"@type":"WebSite","@id":"https:\/\/data-flair.training\/blogs\/#website","url":"https:\/\/data-flair.training\/blogs\/","name":"DataFlair","description":"Learn Today. Lead Tomorrow.","publisher":{"@id":"https:\/\/data-flair.training\/blogs\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/data-flair.training\/blogs\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/data-flair.training\/blogs\/#organization","name":"DataFlair","url":"https:\/\/data-flair.training\/blogs\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/data-flair.training\/blogs\/#\/schema\/logo\/image\/","url":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2016\/07\/Data-Flair.png","contentUrl":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2016\/07\/Data-Flair.png","width":106,"height":48,"caption":"DataFlair"},"image":{"@id":"https:\/\/data-flair.training\/blogs\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/DataFlairWS\/","https:\/\/x.com\/DataFlairWS","https:\/\/www.linkedin.com\/company\/dataflair-web-services-pvt-ltd\/","https:\/\/www.youtube.com\/user\/DataFlairWS"]},{"@type":"Person","@id":"https:\/\/data-flair.training\/blogs\/#\/schema\/person\/7f83c342f5d1632d6f7b4b0b0f447823","name":"DataFlair Team","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/4cf3a74600d131330b8c481d519afd1574093ed89f6d3396a95393ad223eb7cd?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/4cf3a74600d131330b8c481d519afd1574093ed89f6d3396a95393ad223eb7cd?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/4cf3a74600d131330b8c481d519afd1574093ed89f6d3396a95393ad223eb7cd?s=96&d=mm&r=g","caption":"DataFlair Team"},"description":"DataFlair Team creates expert-level guides on programming, Java, Python, C++, DSA, AI, ML, data Science, Android, Flutter, MERN, Web Development, and technology. Our goal is to empower learners with easy-to-understand content. Explore our resources for career growth and practical learning.","url":"https:\/\/data-flair.training\/blogs\/author\/dfteam1\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/posts\/12519","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/comments?post=12519"}],"version-history":[{"count":17,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/posts\/12519\/revisions"}],"predecessor-version":[{"id":148306,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/posts\/12519\/revisions\/148306"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/media\/64101"}],"wp:attachment":[{"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/media?parent=12519"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/categories?post=12519"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/tags?post=12519"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}