{"id":11845,"date":"2018-03-27T06:11:28","date_gmt":"2018-03-27T06:11:28","guid":{"rendered":"https:\/\/data-flair.training\/blogs\/?p=11845"},"modified":"2021-12-04T10:16:43","modified_gmt":"2021-12-04T04:46:43","slug":"scala-comments","status":"publish","type":"post","link":"https:\/\/data-flair.training\/blogs\/scala-comments\/","title":{"rendered":"Scala Comments – Single Line, Multiline, Documentation Comments"},"content":{"rendered":"

In our last tutorial, we discussed Scala Pros and Cons<\/a><\/strong>. In this, Scala Comments Tutorial, we will study various types of comments in Scala: Single Line, Multiline, Documentation Comments with their syntax and example.<\/p>\n

So, let’s explore Scala Comments Tutorial.<\/p>\n

\"Scala<\/a>

Scala Comments with Syntax and Examples<\/p><\/div>\n

2. Define Scala Comments<\/h2>\n

Comments are entities, in your code, that the compiler\/interpreter ignores. You can use them to explain code, and also to hide code details.<\/p>\n

Do you know What is\u00a0 Scala Constructor?<\/a><\/strong><\/p>\n

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

a. Scala Single-Line Comments<\/h4>\n

When you want only one line of a comment in Scala, you can use the characters \u2018\/\/\u2019 preceding the comment.
\nobject Main extends App<\/p>\n

{\r\n    print(\"Hi!\")\r\n    \/\/This is a comment, and will not print\r\n}<\/pre>\n
Here\u2019s the output:
\nHi!<\/p>\n
b. Scala Multiline Comments<\/h4>\n
When your comments will span more than one line, you can use a multiline comment. To declare it, we use the characters \u2018\/*\u2019 and \u2018*\/\u2019 around the comment.
\nobject Main extends App<\/p>\n
{\r\n    print(\"Hi!\")\r\n    \/*This is a multiline comment,\r\n    and will not print\r\n    kbye*\/\r\n}<\/pre>\n
The output:
\nHi!<\/p>\n
Read about\u00a0 Scala Regular Expressions(Regex)<\/a><\/strong><\/p>\n
c. Documentation Comments in Scala<\/h4>\n
A documentation comment is available for quick documentation lookup, and are open for review on pressing Ctrl+Q in the IntelliJ. Your compiler uses these comments to document the source code.
\nWe have the following syntax for creating a documentation comment:
\nobject Main extends App<\/p>\n
{\r\n    print(\"Hi!\")\r\n    \/**\r\n    * This is a documentation comment\r\n    * This is a demo\r\n    *\/\r\n}<\/pre>\n
Output:
\nHi!
\nTo declare such a comment, type the characters \u2018\/**\u2019, and then type something, or press Enter. The IDE will put in a \u2018*\u2019 every time you press enter. To end such a comment, type \u2018\/\u2019 after one of the carets(*).<\/p>\n
So, this was all about Comments in Scala. Hope you like our explanation.<\/p>\n
Conclusion<\/h3>\n
Hence, in this Scala Comments article, we studied Scala has three kinds of comments- single-line, multiline, and documentation comments with their examples and syntax. Still, if we miss something, share with us in the comment box.<\/p>\n
Related Topic-\u00a0\u00a0Scala Control Structures<\/a><\/strong><\/p>\n
Reference<\/a><\/strong>
In our last tutorial, we discussed Scala Pros and Cons. In this, Scala Comments Tutorial, we will study various types of comments in Scala: Single Line, Multiline, Documentation Comments with their syntax and example....<\/p>\n","protected":false},"author":6,"featured_media":31288,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[61],"tags":[4026,12415,12503,12546,12583],"class_list":["post-11845","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scala","tag-documentation-comments","tag-scala-comments","tag-scala-multiline-comments","tag-scala-single-line-comments","tag-scala-tutorial"],"yoast_head":"\nScala Comments - Single Line, Multiline, Documentation Comments - DataFlair<\/title>\n<meta name=\"description\" content=\"Scala Comments: Learn Scala Single-line Comments, Scala Multiline Comments and Scala Documentation Comments in the quick Scala Tutorial on Scala Comments\" \/>\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\/scala-comments\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Scala Comments - Single Line, Multiline, Documentation Comments - DataFlair\" \/>\n<meta property=\"og:description\" content=\"Scala Comments: Learn Scala Single-line Comments, Scala Multiline Comments and Scala Documentation Comments in the quick Scala Tutorial on Scala Comments\" \/>\n<meta property=\"og:url\" content=\"https:\/\/data-flair.training\/blogs\/scala-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-03-27T06:11:28+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-12-04T04:46:43+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/03\/Comments-in-Scala-2.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"628\" \/>\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=\"2 minutes\" \/>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Scala Comments - Single Line, Multiline, Documentation Comments - DataFlair","description":"Scala Comments: Learn Scala Single-line Comments, Scala Multiline Comments and Scala Documentation Comments in the quick Scala Tutorial on Scala Comments","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\/scala-comments\/","og_locale":"en_US","og_type":"article","og_title":"Scala Comments - Single Line, Multiline, Documentation Comments - DataFlair","og_description":"Scala Comments: Learn Scala Single-line Comments, Scala Multiline Comments and Scala Documentation Comments in the quick Scala Tutorial on Scala Comments","og_url":"https:\/\/data-flair.training\/blogs\/scala-comments\/","og_site_name":"DataFlair","article_publisher":"https:\/\/www.facebook.com\/DataFlairWS\/","article_published_time":"2018-03-27T06:11:28+00:00","article_modified_time":"2021-12-04T04:46:43+00:00","og_image":[{"width":1200,"height":628,"url":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/03\/Comments-in-Scala-2.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":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/#article","isPartOf":{"@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/"},"author":{"name":"DataFlair Team","@id":"https:\/\/data-flair.training\/blogs\/#\/schema\/person\/2c58ecb4f73a39f0ef993f1ddfcd7b89"},"headline":"Scala Comments – Single Line, Multiline, Documentation Comments","datePublished":"2018-03-27T06:11:28+00:00","dateModified":"2021-12-04T04:46:43+00:00","mainEntityOfPage":{"@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/"},"wordCount":321,"commentCount":0,"publisher":{"@id":"https:\/\/data-flair.training\/blogs\/#organization"},"image":{"@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/#primaryimage"},"thumbnailUrl":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/03\/Comments-in-Scala-2.jpg","keywords":["Documentation Comments","Scala Comments","Scala Multiline Comments","Scala Single-line Comments","scala tutorial"],"articleSection":["Scala Tutorials"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/data-flair.training\/blogs\/scala-comments\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/","url":"https:\/\/data-flair.training\/blogs\/scala-comments\/","name":"Scala Comments - Single Line, Multiline, Documentation Comments - DataFlair","isPartOf":{"@id":"https:\/\/data-flair.training\/blogs\/#website"},"primaryImageOfPage":{"@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/#primaryimage"},"image":{"@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/#primaryimage"},"thumbnailUrl":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/03\/Comments-in-Scala-2.jpg","datePublished":"2018-03-27T06:11:28+00:00","dateModified":"2021-12-04T04:46:43+00:00","description":"Scala Comments: Learn Scala Single-line Comments, Scala Multiline Comments and Scala Documentation Comments in the quick Scala Tutorial on Scala Comments","breadcrumb":{"@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/data-flair.training\/blogs\/scala-comments\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/#primaryimage","url":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/03\/Comments-in-Scala-2.jpg","contentUrl":"https:\/\/data-flair.training\/blogs\/wp-content\/uploads\/sites\/2\/2018\/03\/Comments-in-Scala-2.jpg","width":1200,"height":628,"caption":"Scala Comments with Syntax and Examples"},{"@type":"BreadcrumbList","@id":"https:\/\/data-flair.training\/blogs\/scala-comments\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Blog Home","item":"https:\/\/data-flair.training\/blogs\/"},{"@type":"ListItem","position":2,"name":"Scala Tutorials","item":"https:\/\/data-flair.training\/blogs\/category\/scala\/"},{"@type":"ListItem","position":3,"name":"Scala Comments – Single Line, Multiline, Documentation Comments"}]},{"@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\/2c58ecb4f73a39f0ef993f1ddfcd7b89","name":"DataFlair Team","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/1ce4a0e3e542444fc73bbebf83e89e8b73e2d95ccb1fcee64da9945f078b97c5?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/1ce4a0e3e542444fc73bbebf83e89e8b73e2d95ccb1fcee64da9945f078b97c5?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/1ce4a0e3e542444fc73bbebf83e89e8b73e2d95ccb1fcee64da9945f078b97c5?s=96&d=mm&r=g","caption":"DataFlair Team"},"description":"The DataFlair Team provides industry-driven content on programming, Java, Python, C++, DSA, AI, ML, data Science, Android, Flutter, MERN, Web Development, and technology. Our expert educators focus on delivering value-packed, easy-to-follow resources for tech enthusiasts and professionals.","url":"https:\/\/data-flair.training\/blogs\/author\/dfteam2\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/posts\/11845","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\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/comments?post=11845"}],"version-history":[{"count":5,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/posts\/11845\/revisions"}],"predecessor-version":[{"id":104821,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/posts\/11845\/revisions\/104821"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/media\/31288"}],"wp:attachment":[{"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/media?parent=11845"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/categories?post=11845"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/data-flair.training\/blogs\/wp-json\/wp\/v2\/tags?post=11845"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}