Kotlin 공식문서에 나오는 Convention을 일부 차용하여 따를 예정입니다.

Coding conventions | Kotlin

[팁] 카멜 케이스 / 케밥 케이스 / 파스칼 케이스 / 스네이크 케이스 란?

  1. Package 이름은 항상 소문자로 작성하고, 밑줄을 사용하지 않는다. (부득이한 경우에 사용)

*package* org.sopt.sample.presentation.home.viewmodel

  1. Class의 이름은 파스칼 케이스 따른다.

GalleryFragment, GalleryViewModel, HomeActivity

  1. 함수 이름과 파라미터, 지역변수는 모두 첫 단어의 맨 앞글자를 항상 소문자로 하고 이후로는 Camel Case를 따른다.
private lateinit var musicAdapter: MusicAdapter
...
private fun setAdapter() {
        musicAdapter = MusicAdapter(requireContext())
    }
  1. 상수의 경우 const와 함께 쓰이거나 top-level에서 val과 함께 주소뿐만 아니라 값까지도 불변으로 사용할 경우에 밑줄(_)과 함께 대문자로만 표기한다.
    const val SOPT_BAST_URL = "..."
    const val SOPT_MUSIC_BAST_URL = "..."
    const val REQRES_BASE_URL =  "<https://reqres.in/>"
    const val APPLICATION_JSON = "application/json"
  1. 가능한 변수명, 클래스명에 약어를 사용하지 않는다. 다른 팀원이 그 이름을 처음 보았을 때도 어떤 역할을 수행하는 변수, 컴포넌트인지 이해할 수 있도록 작성한다.

✅ Resource Naming(XML, Drawable)은 가능한 다음과 같은 규칙을 따릅니다.

예시

예시

XML Component ID

<aside> 💡 단, style naming은 피그마와의 통일성을 위해 피그마의 네이밍을 따라갑니다.

</aside>