Coding Convention

omos-aos 프로젝트는 아래와 같은 코딩 컨벤션을 따릅니다.

기본적으로 안드로이드 Kotlin 스타일 가이드와 Kotlin Coding convetion 공식 문서의 스타일 가이드를 따릅니다.

1. File naming

1-1. Class files

모든 클래스 파일명은 파스칼 케이스로 작성됩니다. / ex: MainActivity, FirstFragment, OmosDialog

1-2. Resource files

모든 리소스 파일명은 스네이크 케이스로 작성됩니다. / ex: activity_main, fragment_first, menu_bottom_nav

1-2-1. Drawable files

• 메뉴, 버튼 등에 대한 아이콘은 ic_이름 으로 표현합니다. / ex: ic_home, ic_omos_title
• 사진과 같이 벡터로 표현하기 힘든 이미지는 img_이름 으로 표현합니다. / ex: img_main_screen

1-2-2. Layout files

• 레이아웃 파일명은 컴포넌트 이름을 시작으로한 스네이크 케이스로 작성됩니다.
• RecyclerView와 같은 리스트 형식 아이템 레이아웃은 item_이름 으로 작성됩니다.
• include 태그로 재사용할 수 있는 레이아웃은 layout_이름 으로 작성됩니다.

Component	Class Name	Layout Name
Activity	MainActivity	activity_main.xml
Fragment	HomeFragment	fragment_home.xml
Dialog	DoubleCheckDialog	dialog_double_check.xml
AdapterView item	---	item_record.xml
Include layout	---	layout_input.xml

1-2-3. Menu files

모든 메뉴 파일명은 menu_이름 으로 작성됩니다. / ex: menu_bottom_nav, menu_overflow

1-2-4. Value files

모든 값 파일명은 복수형태의 단어로 작성됩니다. / ex: strings.xml, styles.xml, themes.xml, colors.xml, dimens.xml, attrs.xml

2. Kotlin

2-1. Import

특정 라이브러리를 가져올 때 라이브러리의 모든 메서드를 가져오는 * 정규화를 사용하지 않습니다.
자동으로 import 구문이 * 로 변경되는 경우에는 설정에서 해당 기능을 해제합니다.

Good (o)

import foo.Bar

Bad (x)

import foo.*

3. XML

3-1. id

• 모든 뷰의 id는 스네이크 케이스로 작성됩니다. / ex: tv_title, et_password
• 뷰 그룹의 경우 Layout을 제외한 이름을 표현합니다. / ex: LinearLayout -> linear_
• 뷰의 이름에 대문자가 2개 이상인 경우 각 대문자들을 따서 표현합니다. / ex: AbcDeFgh -> adf_
• 뷰의 이름에 대문자가 1개인 경우 모든 이름을 표현합니다. / ex: Abcde -> abcde_

Element	Prefix
TextView	tv_
EditText	et_
ImageView	iv_
RecyclerView	rv_
ScrollView	pb_
NestedScrollView	pb_
Button	btn_
Menu	menu_
ProgressBar	pb_
Switch	pb_
LinearLayout	linear_
ConstraintLayout	constraint_
FrameLayout	frame_
AbcDeFgh	adf_
Abcdef	abcdef_

3. Etc

• 코드 작성 완료 시 Ctrl+Alt+L or Cmd+Opt+L 로 코드 정렬을 합니다. (단, 특정 라인의 코드가 보기 힘든 경우 수정할 수 있습니다.)
• 단어를 줄이는 것을 지양합니다. / ex: pw -> password