📜  Scala 中的注释

📅  最后修改于: 2022-05-13 01:55:47.486000             🧑  作者: Mango

Scala 中的注释

在我们的代码中,注释是解释器/编译器忽略的实体。我们一般用它们来解释代码,也用来隐藏代码细节。这意味着注释不会成为代码的一部分。它不会被执行,而是仅用于详细解释代码。
换句话说, scala 注释是编译器或解释器不执行的语句。注释可用于提供有关变量、类、方法或任何语句的解释或信息。这也可以用来隐藏程序代码细节。
在 Scala 中,共有三种类型的注释:

  1. 单行注释。
  2. 多行注释。
  3. 文档评论。

在这里,我们将使用它们的语法和示例来解释每种类型:
Scala 单行注释
当我们在 Scala 中只需要一行注释时,我们只想写一行注释,那么我们可以在注释前使用字符“//”。这些字符将使该行成为注释。
句法:

//Comments here( Text in this line only is considered as comment )

例子:

Scala
// This is a single line comment.
 
object MainObject
{
    def main(args: Array[String])
    {
        println("Single line comment above")
    }
}


Scala
// Scala program to show multi line comments
 
object MainObject
{
    def main(args: Array[String])
    {
        println("Multi line comments below")    
    }
     
    /*Comment line 1
     Comment line 2
     Comment line 3*/
}


Scala
// Scala program to show Documentation comments
 
object MainOb
{
    def main(args: Array[String])  
    {
        println("Documentation comments below")    
    }
     
    /**
    * This is geek for geeks
    * geeks coders
    *
    */
}


输出:

Single line comment above

Scala 多行注释
如果我们的注释跨越多行,我们可以使用多行注释。我们在注释周围使用字符“/*”和“*/”。那就是我们在这些字符之间写一个文本,它就变成了一个评论。
句法

/*Comment starts
continues
continues
.
.
.
Comment ends*/

例子

斯卡拉

// Scala program to show multi line comments
 
object MainObject
{
    def main(args: Array[String])
    {
        println("Multi line comments below")    
    }
     
    /*Comment line 1
     Comment line 2
     Comment line 3*/
}

输出

Multi line comments below

Scala 中的文档注释
文档注释用于快速文档查找。这些注释被编译器用来记录源代码。我们有以下用于创建文档注释的语法:
句法

/**Comment start
*
*tags are used in order to specify a parameter
*or method or heading
*HTML tags can also be used 
*such as 

* *comment ends*/

例子

斯卡拉

// Scala program to show Documentation comments
 
object MainOb
{
    def main(args: Array[String])  
    {
        println("Documentation comments below")    
    }
     
    /**
    * This is geek for geeks
    * geeks coders
    *
    */
}

输出

Documentation comments below

对于这样的注释的声明,输入字符'/**',然后输入一些东西,或者我们可以按。所以每次我们按回车的时候,IDE 都会放一个'*'。要结束评论,请在插入符号 (*) 之一后键入“/”。