[kotlin] 네이밍 규칙 설정하기
코틀린은 변수, 함수, 클래스 등의 이름을 정의할 때 특정한 규칙을 따르는 것이 좋습니다. 네이밍 규칙을 잘 지킨다면 코드의 가독성을 높일 뿐만 아니라 유지보수가 쉬워집니다. 아래에는 코틀린에서 널리 사용되는 네이밍 규칙을 안내합니다.
변수 및 상수
변수 및 상수의 이름은 카멜 표기법(camelCase)을 따르며, 의미 있는 이름으로 지어야 합니다.
// 좋은 예
val userName: String = "JohnDoe"
var itemCount: Int = 10
val maxItemCount: Int = 100
// 나쁜 예
val username: String = "JohnDoe" // 카멜 표기법을 따르지 않음
var item_count: Int = 10 // 스네이크 표기법 사용
val q: Int = 100 // 이름이 의미가 없음
함수
함수의 이름 또한 카멜 표기법을 따라야 하며, 함수가 하는 일을 잘 설명하는 이름으로 지어야 합니다.
// 좋은 예
fun calculateTotalPrice() { /*...*/ }
fun getUserInfo() { /*...*/ }
fun isUserLoggedIn() { /*...*/ }
// 나쁜 예
fun calc() { /*...*/ } // 이름이 축약되어 가독성이 떨어짐
fun getUser() { /*...*/ } // 함수가 하는 일을 설명하지 않음
클래스 및 인터페이스
클래스와 인터페이스의 이름은 카멜 표기법을 따르며, 각 단어의 첫 글자를 대문자로 작성해야 합니다.
// 좋은 예
class MyCalculator { /*...*/ }
interface Shape { /*...*/ }
// 나쁜 예
class my_calculator { /*...*/ } // 카멜 표기법을 따르지 않음
interface shape { /*...*/ } // 첫 글자가 소문자임
기타 사항
-
이름을 지을 때 축약어보다는 전체 단어를 사용하는 것이 좋습니다. 예를 들어 “numberOfItems” 대신 “numItems”보다는 “numberOfItems”를 사용하는 편이 좋습니다.
-
의미 있는 이름을 사용하고, 다른 개발자들이 이름만 보고도 해당 요소의 역할을 파악할 수 있도록 노력해야 합니다.
네이밍 규칙을 지키는 것은 좋은 프로그래밍 습관을 형성하는 데 도움이 됩니다. 적절한 이름을 사용하면 코드 이해가 쉬워지며, 유지보수 과정에서도 큰 도움이 될 것입니다.
참고 자료: