Code Convention

Coding Detail Convention

• 중복 구문 피하기
• 세미콜론 가능하면 생략하기
• 후행 쉼표 활용하기
• 기능 개발 시 주석 달아 간략히 기능 설명 써놓기

function name

• 초기화 -> init~~
• 갱신 -> update~~
• 삭제 -> remove~~
• 통신 -> get, delete, put, post 이름에 따라서 함수명 -> getUserList(), postuser(), putProfile , ...

기타

• 화면 비율 px로 확인 후 dp로 변환하여 사용하기
• 캘린더는 material calendarview 사용하기

Kotlin Naming rules

• 클래스/파일명 : PascalCase

  (ex: MainActivity, UserProfile)

• 함수/변수명 : camelCase

  (ex: getUserInfo, userName)

• 패키지명: 기능에 따라 나누고, 소문자로 작성

  (ex: 로그인, 회원가입 파일 들어있는 패키지명 auth)

• 상수 : UPPER_CASE

  (ex: MAX_RETRY_COUNT)

Android-Style-Guide

1. Layout

• xml 파일명 : snake_case [WHAT]_[WHERE]

  (ex: activity_main , fragment_home)

prefix	설명
activity_	Activity에서 쓰이는 layout
fragment_	Fragment에서 쓰이는 layout
dialog_	Dialog에서 쓰이는 layout
view_	CustomView에서 쓰이는 layout
item_	RecyclerView, GridView, ListView등에서 ViewHolder에 쓰이는 layout

2. ID

• View ID : [파일 이름]_[설명]_[뷰 약자] 중간 설명은 camelCase로 작성

  (ex. MainActivity의 요소라면, main_albumlmg_iv)

View Type	View 약자
TextView	tv
EditText	et
RecyclerView	rv
ImageView	iv
Button ImageButton	btn
ScrollView	sv
TabLayout	tl
ViewPager	vp
ToolBar	tb
CardView	cv
Linearlayout	ll
FrameLayout	fl
CheckBox	cb
RadioButton	rb
BottomNavigationView	bnv
FragmentContainerView	fcv
View(밑줄, 경계선, 라인)	view

3. Drawable

• <WHAT>(_<WHERE>)_<DESCRIPTION>(_<SIZE>)
• 이미지가 여러군데에서 활용될 경우, <WHERE>는 생략 가능
• 이미지의 크기가 1개밖에 없는 경우, <SIZE>는 생략 가능

What

Prefix	설명
btn_	버튼으로 쓰이는 이미지
ic_	버튼이 아닌 화면에 보여지는 이미지
bg_	버튼이 아닌 화면에 보여지는 이미지
img_	실제사진이거나 아이콘형태가 아닌 일러스트형태의 이미지
div_	divider로 활용되는 이미지

Selector

상태	Suffix
Normal	_normal
Pressed	_pressed
Focused	_focused
Disabled	_disabled
Selected	_selected