코틀린에서는 명명 규칙을 통해 변수, 함수, 클래스 등의 식별자를 명명하는데 일관성을 부여합니다. 이러한 명명 규칙을 따르면 코드의 가독성이 증가하고, 팀 내에서 일관된 코딩 스타일을 유지할 수 있습니다.
1. 클래스와 타입
- 카멜 표기법(Camel Case)을 사용합니다.
- 첫 번째 단어는 소문자로 시작하고, 그 뒤에 오는 각 단어는 대문자로 시작합니다.
class MyFirstClass
class MyTypeExample
2. 변수와 함수
- 카멜 표기법(Camel Case)을 사용합니다.
- 첫 번째 단어는 소문자로 시작하고, 그 뒤에 오는 각 단어는 대문자로 시작합니다.
val myVariable: Int = 42
fun calculateSum(a: Int, b: Int): Int {
return a + b
}
3. 상수
- 대문자 스네이크 케이스(Upper Snake Case)를 사용합니다.
- 모든 글자를 대문자로 작성하고, 단어 간에는 밑줄(underscore)을 사용합니다.
const val MAX_VALUE: Int = 100
4. 패키지
소문자로만 작성하며, 단어 간에는 점(.)을 사용합니다.
package com.example.myproject
5. 함수 이름 관례
기능을 설명하는 동사로 시작하며, 이후에는 명사 또는 형용사를 사용합니다.
fun calculateSum(a: Int, b: Int): Int {
return a + b
}
6. 일반적인 명명 규칙
- 변수, 함수, 클래스 등의 명명에서는 가능하면 의미 있는 이름을 사용합니다.
- 한 글자의 변수 이름은 피하며, 가능하면 약어 대신 전체 단어를 사용합니다.
- 축약어나 약어를 사용할 경우, 팀 내에서 일관성을 유지해야 합니다.
명명 규칙을 지키면 코드가 읽기 쉽고 이해하기 쉬워집니다. 또한 코드베이스의 일관성을 유지하므로, 협업과 유지보수가 더 효율적으로 이루어집니다. 코드 리뷰나 팀의 코딩 스타일 가이드라인에 따라 명명 규칙을 정의하고 준수하는 것이 좋습니다.
With ChatGPT