👨‍💻 코드 컨벤션

💡 팀 내 코드 컨벤션

1. Kotlin

패키지

• 패키지명은 항상 소문자

함수명

• ViewModel을 observe() 할 때 모아놓는 함수 이름

fun setupXXX()

• 서버에서 데이터를 불러올 때 함수 (return 값 없는 경우)

fun fetchXXX()

• 서버에 저장할 때 함수

fun saveXXX()

• return 값이 있는 데이터를 불러올 때 함수

fun getXXX()

• 복수형을 가져올 땐 뒤에 s 붙이기

fun getProducts()

• BindingAdpater 함수는 bindXXX 형태로 정의

fun bindIsGone(view: View, isGone: Boolean)

기타

• Trailing Comma 사용

data class Moment(val a: Type1, val b: Type2,)

2. Resource

Layout

• <WHAT>_<WHERE>

<WHAT>

Prefix	설명
activity_	Activity에 쓰이는 layout
fragment_	Fragment에 쓰이는 layout
dialog_	Dialog에서 쓰이는 layout
view_	CustomView에서 쓰이는 layout
list_item_	RecyclerView, GridView, ListView 등에서 ViewHolder에 쓰이는 layout
layout_	로 재사용되는 공통의 layout

---

ID

• <WHAT>_<DESCRIPTION>
• View의 대문자를 축약하여 <WHAT>의 Prefix로 사용
• PascalCase 형태의 View는 대문자 축약
  • ex) TextView -> tv_
• View의 이름이 Space, Switch 와 같이 대문자가 1개만 존재하면 모두 소문자로 표현
  • ex) Switch -> switch_

<WHAT>

View	Prefix
TextView	tv_
ImageView	iv_
CheckBox	cb_
RecyclerView	rv_
EditText	et_
ProgressBar	pb_
FrameLayout	fl_
NestedScrollView	nsv_
Space	space_
Switch	switch_
AbcDeFgh	adf_
Abcdef	abcdef_

---

String

• <WHERE>_<DESCRIPTION>
• 다양한 화면에서 사용되는 텍스트라면 all_<DESCRIPTION>
  • ex) all_yes : 네
  • ex) permission_dialog_camera_description: 카메라권한을 요구하는 Dialog의 설명내용

3. Class

UseCase

• List를 가져오는 경우 UseCase의 이름은 GetXXXListUseCase 로 정의
  • s 로 표현하게 되면 단수를 가져오는 클래스와 헷갈리기 때문

Function

• 클래스의 모든 반환형(:<반환형> = )은 표기(= 사용하더라도)
• 클래스에서 return이 single Expression 일 경우, Flow 함수들은 <반환형>: = 사용 | Mapper 함수들은 return 사용해서 반환 | map 함수 사용했을 경우 <반환형>: = ..?

4. Hilt

외부 라이브러리일 경우: @Provides | 사용자 정의 class: @Binds