[코파기 1부] 부록. 자바/코틀린의 네이밍 규칙

 

1. 네이밍 컨벤션 (Coding Convention)

네이밍 규칙, 네이밍 컨벤션, 코딩 컨벤션, 코딩 스타일 등

부르는 이름은 다양하나 이들은 모두 한 가지를 의미합니다.

팀(회사)에서 협업이 쉽게 코드의 작성 스타일을 정한 것인데요.

 

 

농담삼아 프로그래머가 가장 힘들어하는 일은 이름 짓기라는 개발자 유머가 있죠

변수명, 클래스명, 메소드명을 보고 이게 어떤 기능을 하는구나! 어떤 동작을 하는구나!를

직관적으로 알아볼 수 있어야 하기 때문입니다.

 

자바/코틀린의 경우 일반적으로 사용되는 네이밍 규칙이 있고,

안드로이드 역시 구글에서 정한 코드 스타일 가이드라인이 있습니다.

 

하지만, 팀(회사)에서 자체적인 코드 스타일을 정해놓고, 팀 멤버들끼리만 협업을 진행한다면

언어 / 프레임워크의 기본 코딩 스타일을 굳이 지킬 필요는 없습니다.

 

이 글에서 설명할 내용은, 팀에서 정한 별도의 코딩 스타일이 없을 경우,

코드의 가독성을 향상시켜 줄 자바/코틀린의 기본 네이밍 규칙에 대해 알아보겠습니다.

 

 

2. 카멜 케이스 (Camel Case)

      

      

      

    
    

      <kotlin />
    
Get Small Number
-> getSamllNumber // 첫 번째 글자는 소문자로 하되, 나머지 단어의 첫 글자는 대문자로 표현

 

카멜 표기법 혹은 카멜 케이스는

단어의 첫 글자는 대문자로, 나머지는 소문자로 나타내는 방식입니다.

Get Small Number를 표현할 때는 GetSmallNumber / getSmallNumber와 같이,

띄어쓰기를 제거하고 각 단어의 첫 글자만 대문자료 표기하는 방법입니다.

 

Camel은 낙타를 뜻하는 영어단어인데,

중간에 불록하게 튀어나온게 낙타의 혹을 닮았다 하여 붙여진 이름입니다.

나름 적절한 이름인 것 같네요.

 

3. 파스칼 케이스 (Pascal Case)

      

      

      

    
    

      <kotlin />
    
Get Small Number
-> GetSmallNumber

 

파스칼 케이스는 맨 앞 글자까지 대문자로 표기하는 표기법입니다.

그러나 이것도 그냥 카멜 케이스로 쳐서 대문자 카멜 케이스로 부르곤 합니다.

 

해당 글에서는 파스칼 케이스라는 용어 대신,

대문자 카멜 케이스라는 용어를 사용하겠습니다.

 

 

4. 클래스 네이밍

      

      

      

    
    

      <kotlin />
    
class BookRecord {
	fun xxx() { }
}

클래스는 첫 글자를 대문자로 한 카멜 케이스를 사용합니다.

 

 

5. 메소드(함수), 변수

      

      

      

    
    

      <kotlin />
    
val tempValue = 3 // 첫 번째 글자를 소문자로 한 카멜 표기법 사용

fun getSmallNumber(a: Int, b: Int):Int // 첫 번째 글자를 소문자로 한 카멜 표기법 사용

 

메소드와 변수는 첫 글자를 소문자로 한 카멜 케이스를 사용합니다.

 

 

6. 상수 (Constant)

      

      

      

    
    

      <kotlin />
    
val TEMP = 0
val TEMP_VALUE = 1

 

상수는 모든 글자를 대문자로 표기하면스

띄어쓰기를 언더바(_)로 표기하는 스네이크 표기법 (Snake Case)를 사용합니다.

언더바로 이어져 있는게 마치 뱀 같아서 붙은 이름입니다.

 

 

7. 패키지 (Package)

 

패키지는 오직 소문자만을 사용합니다. 연속된 단어가 있다면 그냥 띄어쓰기나 언더바 없이 모두 소문자로 씁니다.

ex> hello world

-> helloworld (o)

-> helloWorld (x)

-> hello_world (x)

모두 소문자이기 때문에, 패키지는 이름이 길어지면 단어 구분이 어렵습니다.

때문에 최대한 한 단어로 하되, 한 단어로 줄일 수 없다면 최대한 간결하고 짧게 쓰는게 좋습니다.

 

물론, 구글에서 권장하는 코틀린 스타일 가이드 라인일 뿐, 팀/회사에서 패키지를 카멜 표기법으로 쓰기로 정해도 무방합니다.

 

 

 

더 자세한 내용을 보고 싶다면 아래 구글의 Android Developers의 Kotlin 스타일 가이드를 참고하시기 바랍니다.

https://developer.android.com/kotlin/style-guide?hl=ko 

Kotlin 스타일 가이드  |  Android Developers

 

 

- 수정내용

23.04.17 패키지 표기법 요류 정정 카멜 표기법 -> 모두 소문자

도움주신 우파카님 감사합니다.