안드로이드 컨벤션

1. 기본

• 기본적으로 공식문서인 Kotlin Coding Conventions과 Kotlin style guide를 준수한다.

1.1. 안드로이드 스튜디오

• ktlint를 사용한다.

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

• Optimize imports (Command + Option + O) : 사용하지 않는 Class를 import하고 있는 경우 제거해준다.

• Reformat Code (Command + Option + L) : 코드의 Kotlin Style Guide를 적용하여 Code를 Reformat한다.

2. Resource Naming Convention

2.1. ID

• _ 방식으로 사용한다.

• TextView tv_

• ImageView iv_

• EditText et_

• Button, ImageButton btn_

• Toolbar tb_

• ConstraintLayout cl_

• LinearLayout ll_

• BottomNavigationView bnv_

• Fragment fr_

• Menu menu_

• custom view의 경우 prefix에 custom_ 를 추가한다.

2.2. Layout

• _ 방식으로 사용한다.

• Activity activity_

• Fragment fragment_

• Dialog dialog_

• CustomView view_

• Item item_

예시

SignInActivity.kt → activity_sign_in.xml

CustomCalendarView.kt → view_custom_calendar.xml

2.3. Drawable

• _ 방식으로 사용한다.

• Icon ic_

• Image img_

• Background bg_

• selector selector_

• Shape <shame>_<color>_<radius>_<value>

예시 : ic_error.xml, rectangle_yellow_radius_20.xml

2.4. Menu

• menu_ 방식으로 사용한다.

2.5. Color

• 앞에 형용사를 붙여 색을 정의한다.

예시: dark_red , light_red

2.6. String

• WHERE/WHAT_DESCRIPTION 방식을 사용한다.

• 단, format string인 경우 format_<WHERE/WHAT>_ 방식을 사용한다.

2.7. Style

• MaterialComponents.에서 Component을 활용한다.

예시 : 
<style name="TextSubtitle1" parent="TextAppearance.MaterialComponents.Subtitle1">
        <item name="android:textColor">@color/shoppi_black_01</item>
</style>

3. 함수명

• DO/WHAT 방식을 사용한다.

• CRUD에 따른 함수명

Create - create<WHAT>
Read - return 값이 있는 경우 : get<WHAT>, 없는 경우 : fetch<WHAT>
Update - update<WHAT>
Delete - delete<WHAT>

4. 변수명

• Boolean Type은 앞에 is 또는 has를 붙인다.

  약자로 줄여쓰지 않는다.

• const 변수는 Upper snake case로 한다.

5. 클래스, 인터페이스명

• 방식을 사용한다.

예시 : UserData, UserRepository, UserDataSource

6. 앱 플로우