Scala编码规范与最佳实践-格式与命名

最新推荐文章于 2021-10-26 07:55:34 发布

转载最新推荐文章于 2021-10-26 07:55:34 发布 · 276 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://github.com/liushuchun/scala_coding_convention

文章标签：

#scala #代码规范

本文介绍了Scala编程的代码格式规范，包括缩进、导入、变量声明、接口方法的返回类型声明以及集合和泛型的命名约定。强调了简洁性和可读性在编程中的重要性，并提供了关于避免多余花括号的建议。此外，还讨论了在Java和Scala中Map的类型参数命名差异。

格式与命名

代码格式
用两个空格缩进。避免每行长度超过100列。在两个方法、类、对象定义之间使用一个空白行。
优先考虑使用val，而非var。
当引入多个包时，使用花括号：

import jxl.write.{WritableCell, Number, Label}

当引入的包超过6个时，应使用通配符_：

import org.scalatest.events._

4）若方法暴露为接口，则返回类型应该显式声明。例如：

    def execute(conn: Connection): Boolean = {
      executeCommand(conn, sqlStatement) match {
        case Right(result) => result
        case Left(_) => false
      }
    }

集合的命名规范
xs, ys, as, bs等作为某种Sequence对象的名称；
x, y, z, a, b作为sequence元素的名称。
h作为head的名称，t作为tail的名称。

6）避免对简单的表达式采用花括号；

//suggestion
def square(x: Int) = x * x

//avoid
def square(x: Int) = {
     x * x
}

泛型类型参数的命名虽然没有限制，但建议遵循如下规则：
A 代表一个简单的类型，例如List[A]
B, C, D 用于第2、第3、第4等类型。例如：
class List[A] {
def map[B](f: A => B): List[B] = …
}
N 代表数值类型

**注意：**在Java中，通常以K、V代表Map的key与value，但是在Scala中，更倾向于使用A、B代表Map的key与value。