Skip to content

Kotlin Convention

doyeon edited this page Jan 25, 2022 · 2 revisions

참고 : PRNDcompany의 android style guide, TeamCARDNA의 android coding convention

1. 기본

1.1. 안드로이드 스튜디오

안드로이드 스튜디오의 Optimize imports 기능Reformat Code 기능을 이용한다.

  • Optimize imports (Ctrl+Alt+O) : 사용하지 않는 Class를 import하고 있는 경우 제거해준다.
  • Reformat Code (Ctrl+Alt+L) : 코드의 Kotlin Style Guide를 적용하여 Code를 Reformat한다.

2. Kotlin

2.1. Class

  • <DESCRIPTION><WHAT>
  • Prefix는 해당 클래스와 관련성이 높은 것으로 임의로 작성한다.

예시

MainActivity
UserViewModel
WriteFragment

2.2 Method

  • lowerCamelCase
  • 복수형을 가져올 때는 뒤에 s를 붙인다
Word Description
show Invisible한 것을 Visible하게 바꾸는 동작
check 어떤 것을 확인한 후 boolean 또는 값으로 반환하는 동작
is 어떤 것인지 확인한 후 boolean으로 반환하는 동작
has 어떤 것을 가지고 있는지 확인 후 boolean으로 반환하는 동작
setup ViewModel을 observe()할때 모아놓는 함수 이름
fetch 서버에서 데이터를 불러올때 함수 이름
save 서버에 저장할때 함수 이름
get Return이 있는 데이터를 불러올때 함수 이름
find 특정 객체를 찾는 함수이름

예시

showList
updateContacts

2.3 Variable

  • lowerCamelCase

예시

isEnd
viewPagerAdapter