2. Android Coding Convention

안드로이드 코딩 컨벤션 요약

1. 알아두면 좋은 단축키

1.1 윈도우

• Ctrl + Alt + L -> 코드 정렬
• Ctrl + Alt + O -> 쓸모없는 임포트 제거
• / + Ctrl -> 주석추가 및 해제
• Ctrl + P -> 파라미터 미리보기
• Ctrl + (이동하고 싶은 파일)좌클릭 -> 클릭한 파일로 이동
• Ctrl + Shift + K ->GitHub push 단축어
• Ctrl + Shift + F -> 전체 검색
• Shift + F6 -> 파일명 및 변수명 변경

1.2 맥북

• Option + Command + L -> 코드 정렬
• Ctrl + Option + O -> 쓸모없는 임포트 제거
• / + Command -> 주석추가 및 해제
• Command + P -> 파라미터 미리보기
• Command + (이동하고 싶은 파일)좌클릭 -> 클릭한 파일로 이동
• Shift + Command + K ->GitHub push 단축어
• Shift + Command + F -> 전체 검색
• Fn + Shift + F6 -> 파일명 및 변수명 변경

2. 네이밍

2.1. 레이아웃 View 네이밍 예시

• @+id/tv_login
• @+id/et_password
• @+id/btn_login

2.1.1. 레이아웃 View 레이밍 카테고리

• TextView -> tv_
• ImageView -> iv_
• EditText -> et_
• Button, ImageButton -> btn_ (일반 버튼이 아니라 marterial button 사용할 것입니당)
• ConstraintLayout -> layout_
• BottonNavitaionView -> bnv_

2.2. 파일명

• xml 파일명 -snake_case 적용
  • activity_sign_in.xml, fragment_sign_up.xml, item_user.xml (리사이클러뷰 아이템 레이아웃은 “item_”로 시작!)
• Drawable 파일명
  • 역시 xml 이기 때문에 snake_case를 적용한다. 자세한 내용은 아래를 참고한다.
  • icon은 “ic_” -> ic_error.xml
  • image는 “img_” -> img_default_user.png
  • shape는 “shape_” -> shape_border_radius10.xml
  • selector는 “selector_” -> selector_edittext_background.xml
• 클래스 파일명
  • UpperCamelCase 적용
  • MainActivity.kt, UserViewModel.kt, WriteFragment.kt, UserInfo.kt
• 함수명
  • 동사형태로 작성하고, lowerCamelCase 적용
  • fun showList(), fun updateContacts()
• 변수명
  • 명사형태로 작성하고, lowerCamelCase 적용
  • isEnd(Boolean 타입 제외), viewPagerAdapter