Kotlin 코드 스타일 가이드

1. 명명 규칙 (Naming Conventions)

• 클래스 및 인터페이스 이름: PascalCase를 사용하며, 명사 또는 명사구를 사용합니다.
  • 예: class UserManager, interface DataProvider
• 함수 및 변수 이름: camelCase를 사용하며, 동사나 동사구를 사용합니다.
  • 예: fun processOrder(), var itemCount
• 상수: 대문자와 언더스코어를 사용합니다.
  • 예: const val MAX_USER_COUNT = 100

2. 간결한 함수 (Concise Functions)

• 단일 표현 함수: 반환 타입이 명확한 경우, 단일 표현 함수를 사용하여 간결하게 작성합니다.
  • 예: fun isEven(number: Int) = number % 2 == 0

3. 타입 추론 활용 (Type Inference)

• 변수 타입 생략: 컴파일러가 타입을 추론할 수 있는 경우, 변수 타입을 생략합니다.
  • 예: val name = "Kotlin"

4. 코틀린 표준 함수 활용 (Use of Kotlin Standard Functions)

• let, apply, with, run, also: 코틀린 표준 라이브러리의 범위 함수를 적절히 활용하여 코드의 가독성을 높입니다.
  • 예: user?.let { println(it.name) }

5. Null 안전성 (Null Safety)

• 널 가능성 고려: 널 가능 타입(?)을 명시하고, ?., ?:, !! 연산자를 적절히 사용합니다.
  • 예: val length = text?.length ?: 0

6. 클래스 및 프로퍼티 설계 (Class and Property Design)

• 데이터 클래스 활용: 데이터 보관 목적의 클래스는 data class를 사용합니다.
• 지연 초기화: 필요할 때까지 객체 생성을 연기하기 위해 lazy 델리게이트를 사용합니다.
  • 예: val session by lazy { createSession() }

7. 문자열 템플릿 사용 (String Templates)

• 변수 삽입: 문자열 내에서 $를 사용하여 변수 값을 삽입합니다.
  • 예: val greeting = "Hello, $name!"

8. 람다식 스타일 (Lambda Style)

• 괄호 밖 람다: 함수의 마지막 인자가 람다식인 경우, 괄호 밖에 람다식을 작성합니다.
  • 예: list.filter { it > 0 }

9. 주석 및 문서화 (Comments and Documentation)

• KDoc 사용: 공개 API에 대한 문서화는 KDoc 형식을 사용합니다.
• 설명적 주석: 코드의 의도를 명확히 설명하는 주석을 작성합니다.

10. 일관된 포맷팅 (Consistent Formatting)

• 공백 및 들여쓰기: Kotlin 공식 스타일 가이드를 따라 적절한 공백과 들여쓰기를 사용합니다.
• 줄바꿈: 가독성을 위해 필요에 따라 적절한 줄바꿈을 사용합니다.