Scala 中的注释

在 Scala 中我们可以用注释来对代码进行说明和解释。注释可分为 单行注释 和 多行注释 两种类型。

单行注释

使用 // 符号可以在代码中添加单行注释，这个符号后的所有内容都被视为注释内容，直到行末停止。

val a = 3 // 定义一个变量a，并赋初值3

多行注释

使用 /* */ 符号可以在代码中添加多行注释，这个符号对之间的所有内容都被视为注释内容。

/*
这段代码的作用是定义一个函数，函数名为 sum，
输入两个整数类型参数，返回二者之和
*/
def sum(a: Int, b: Int): Int = {
    a + b // 返回a和b的和
}

文档注释

Scala 还支持文档注释，用于生成 API 文档。文档注释使用 /** */ 符号，与多行注释不同的是，文档注释支持一些特定的标记，例如 @param，@return 等等。

/**
* 这个函数用于计算两数之和。
* @param a: Int 第一个数
* @param b: Int 第二个数
* @return 返回两数之和
*/
def sum(a: Int, b: Int): Int = {
    a + b
}

在文档注释中，我们可以使用以下标记：

• @param：用于说明函数的参数，例如 @param a: Int 表示参数名为 a，类型为 Int。
• @return：用于说明函数的返回值，例如 @return 返回两数之和。
• @throws：用于说明当函数出现异常时的情况，例如 @throws ArithmeticException 表示函数可能会抛出 ArithmeticException 异常。
• @note：用于添加注释。
• @example：用于添加例子。

文档注释可以使用工具将其转换为 HTML 格式，方便生成 API 文档。

总之，注释是程序员写代码时必不可少的一部分，能帮助别人更快地理解代码，也能帮助自己更好地阅读代码。学会如何写好注释对于一个程序员来说，是至关重要的技能之一。