• 목차

Class

1. Property 선언과 initializer blocks
2. Secondary constructors
3. Method 선언
4. Companion Object

class Layout() {
    // Property
    var name = "name"
    val age: Int

    // Initializer block
    init {
        age = 20
    }

    // Secondary constructors
    constructor(_name: String) : this() {
        name = _name
    }

    // Companion object
    companion object {
        private const val CONST_VAL = 5
    }
}

• Method 선언을 알파벳이나 가시성으로 정렬하지 말고, 확장 메서드와 일반 메서드를 구분하지 말라.
• 대신 관련 있는 것들끼리 묶어서 클래스를 위에서부터 아래로 보면서 로직을 따라갈 수 있도록 하라.
• 순서를 선택하고 고정하라
  • 모든 클래스들은 고수준부터 순서대로 정의되던가 반대 순서로 정의되던가 순서를 결정해서 이 **순서를 항상 고수**하라.
• Nested classes는 그 클래스들을 사용하는 코드 다음에 위치시켜라.
  • 만약 그 클래스들이 외부에서 사용되고 클래스 내에서는 참조되지 않는다면, companion object 뒤인 클래스의 마지막에 위치시켜라.
• Interface를 구현하는 경우, 인터페이스에 정의된 순서와 동일하게 멤버 함수를 구현하라.
  • 만약 필요한 private method가 있다면 해당 interface에 있는 메서드를 구현한 메서드 다음에 넣어라.
• overloads 메서드들은 항상 묶어서 둬라.

Naming Rules

• Package 이름
  • 항상 lowercase이고 underscores(_)는 사용 금지
  • 여러 단어로 된 이름은 권장하지 않음.
  • 하지만 꼭 여러 단어로 된 이름을 사용해야 한다면 camelcase로 정의하라. (ex: myProject)
• Class나 objects 이름
  • 항상 uppercase로 시작하고 camelcase 사용 (ex: DeclarationProcessor)
• Function 이름
  • properteis나 local variables는 lowercase로 시작해서 camelcase 사용하고, underscores 사용 금지.
  • 예외적으로 클래스의 인스턴스를 생성하는 팩토리 함수는 추상 리턴 타입과 같은 이름을 가질 수 있다.

// normal property and local variable
fun processDeclarations() { /*...*/ }
var declarationCount = 1

// Factory function
interface Foo { /*...*/ }

class FooImpl : Foo { /*...*/ }

fun Foo(): Foo { return FooImpl() }

• Property 이름

  • const로 선언된 상수 이름 또는 Top-level/object에 선언된 val은 uppercase 사용하고 단어는 underscore로 구분한다.
  • Mutable 데이터를 가지는 top-level/object 프로퍼티의 이름은 camelcase로 이름 짓는다.
  • 싱글톤 객체에 대한 참조를 가지는 프로퍼티의 이름은 객체 선언과 동일한 이름을 사용할 수 있다.

  // constants
  const val MAX_COUNT = 8
  
  // top-level or object val
  object {
       val USER_NAME_FIELD = "UserName"
  }
  
  // mutable data를 가지는 top-level or object property
  val mutableCollection: MutableSet<String> = HashSet()
  
  // singleton 객체 참조하는 property
  val PersonComparator: Comparator<Person> = /*...*/
  

• Test methods 이름

  • backticks(`)로 묶어서 공백을 포함한 이름을 사용할 수 있다.