Naming Convention

naming convention은 다음을 따른다.(많이 사용할 것 같은 variable의 convention에는 강조 표시를 해둠)

variable type	convention	example
function, method	camelCase	`def multiplyInt(int1:Int, int2:Int): Int`
variable	camelCase	`val serverPort = 1000`
class	PascalCase	`class ClusterManager`
trait	PascalCase	`trait Expresstion`
object	PascalCase	`object Configuration`
constant	uppercase + underscore(_)	`val DEFAULT_PORT`
enumeration	uppercase + underscore(_)	`TRIM_BEFORE_SIGN`
package	lowercase ASCII	`package com.databricks.resourcemanager`

(camelCase는 lowerCamelCase로, PascalCase는 UpperCamelCase라 불리기도 한다)

Spacing and Indentiation

operator(=, +, -)의 앞뒤에는 space를 둔다

def add(int1: Int, int2: Int): Int = int1 + int2

, 뒤에는 space를 둔다

Seq("a", "b", "c") // do this

Seq("a","b","c") // don't omit spaces after commas

: 뒤에는 space를 둔다

// do this
def getConf(key: String, defaultValue: String): String = {
  // some code
}

// don't put spaces before colons
def calculateHeaderPortionInBytes(count: Int) : Int = {
  // some code
}

// don't omit spaces after colons
def multiply(int1:Int, int2:Int): Int = int1 * int2

~~들여쓰기를 할 때에는 2개의 space를 원칙으로 한다~~
- ~~method를 정의할 때에는 4개의 space를 원칙으로 하나, 2개의 space로 통일~~
~~띄어쓰기의 경우 보통(class, method 정의 등)에는 1개만 사용하지만, class나 object를 정의할 때에는 2개를 사용한다.~~
들여쓰기는 tab 하나

Parentheses: ()

조건문이나 반복문에서 단 한줄의 코드가 있다 하더라도 중괄호를 사용한다

// Correct:
if (true) {
  println("Wow!")
}

// Correct:
if (true) statement1 else statement2

// Correct:
try {
  foo()
} catch {
  ...
}

// Wrong:
if (true)
  println("Wow!")

// Wrong:
try foo() catch {
  ...
}

Comment

주석과 관련된 style guide도 있지만, clean code에 근거하여 주석은 정말 필요한 경우를 제외하고 사용하지 않기로 한다. 다음 경우에 대해서는 주석을 작성해도 무관하다.

information comment: 특정한 format으로 값을 받아야 하거나 단위에 대한 명시가 필요한 경우