170530(화) - Kotlin docs(Coding Conventions)

Kotlin docs

Coding Conventions

Naming style

- camelCase 사용 (이름에 밑줄은 지양)

- type은 upper case

- methods and properties 시작은 lower case

- 4 space indentation

- public functions은 documentation이 있어야 한다.

Colon

- super type 과 type 사이에 공백으로 구분

- instance와 type 사이에는 공백 없음

interface Foo<out T : Any> : Bar {

fun foo(a: Int): T

}

Lambdas

- 람다식에서는 중괄호 주위에 공백 사용

- 짧은 람다식에서는 explicitly parameter 대신 it 을 사용하는것이 좋다.

- nested lambdas에서는 parameter는 항상 explicit 하게 선언되어야 한다.

list.filter { it > 10 }.map { element -> element * 2 }

Class header formatting

- longer headers 이면 constructor argument를 개행해서 들여쓰기 해야한다.

- inheritance 라면 괄호와 같은 라인이여야 한다.

- multiple interface 이면 super class 호출이 먼저고 그다음 개행해서 작성한다.

class Person(id: Int, name: String)

class Person(

id: Int,

name: String,

surname: String

) : Human(id, name) {

...

}

class Person(

id: Int,

name: String,

surname: String

) : Human(id, name),

   KotlinMaker {

...

}

Unit

- return 이 Unit이면 return type 생략 가능

fun foo() {

}

Functions VS properties

다음과 같은 특징을 지니고 있으면 property를 쓰세요

- throw가 없음

- O(1) 복잡도

- 쉬운 계산 또는 first run에서 cached

- invocation에 대해서 동일한 return