Skip to content

Coding Convention

Jump to bottom
Grandelwald edited this page Jan 11, 2022 · 2 revisions

➡️ Coding Convention

Spark_Android_Coding Convention 을 토대로 작성하였습니다.

사람마다 변수명을 적는 방식이 다르기 때문에 가독성을 높이기 위해서 Kotlin 언어공식 코딩 컨벤션을 따랐다. 링크 참조

➡️ 코드 관련

✅ function

  • Lower Camel Case 사용
fun sparkFunction()

✅ function name

  • Screaming Snake Case 사용
  • 초기화 => init~~~
  • 갱신 => update~~~
  • 삭제 => remove~~~
  • 통신 => get, delete, put, post 이름에 따라서 함수명 ex) getUserList(), postUser(), putProfile(),...
set[ItemName]ClickListener()
set[AdapterName]Adapter()
set[ValueName]Oberseve()

✅ variable

  • Lower Camel Case 사용
val sparkVariable
var sparkVariable

✅ class

  • Upper Camel Case 사용
class SparkClass

✅ interface

  • Upper Camel Case 사용
interface SparkInterface

✅ const val

  • Screaming Snake Case 사용
const val SPARK_VALUE

➡️ UI 관련

✅ xml file name

  • Snake Case 사용
activity_main.xml
fragment_spark.xml
item_spark(where)_feed(what).xml
menu_(where)_(what).xml
selector_(where)_(what).xml

팀원들과 회의를 통해서 서로 알아보기 쉽도록 어느 위치에 어느 뷰인지를 명시했음

✅ xml id

  • Snake Case 사용
tv(view)_main(where)_nickname(what)
* TextView => tv
* EditText => et
* RecyclerView => rv
* ImageView => iv
* Button, ImageButton => btn
* xxLayout => layout
* ViewPager => vp
* TabLayout => tab
* Chip => chip
* Toolbar => toolbar
* ScrollView => sv
* BottomNavigation => bottom_nav
* FragmentContainer => container
* View(밑줄, 경계선, 라인) => view

이외에는 => 카멜케이스 앞에 대문자 따거나 너무 어떤 뷰인지 감이 안오면 풀네임 써도 ㅇㅋ

✅ drawable file name

  • 중복 생성을 방지하기 위하여 목적과 형태를 명확하게 표현
**from Zeplin, Figma**
* Button 아이콘 => Ic_[where]_[what]
* 이미지 => img_[where]_[what]
* 배경 => bg_[where]_[what]

이 아래는 우리가 제작하는 drawable 파일!!

State List Drawable (checked, unchecked, selected, unselected, ...)

  • selector_[where]_[what].xml
  • 아래와 같은 파일
<?xml version="1.0"encoding="utf-8"?>
<selector xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:drawable="@drawable/btn_main_keepin_checked" 
					android:state_checked="true" />
    <item android:drawable="@drawable/btn_main_keepin_unchecked"
					android:state_checked="false" />
</selector>

Shape Drawable ( button background, dialog background, ...)

  • shape_[color][fill/line/fill_line][radiusNum]_[shape].xml
  • shape => rect, tri, circle
  • 아래와 같은 파일
<?xml version="1.0" encoding="utf-8"?>
<shape xmlns:android="http://schemas.android.com/apk/res/android"
    android:shape="rectangle">
    <solid android:color="@color/black_cc000000" />
    <corners android:radius="4dp" />
</shape>

✅colors.xml

  • 비슷한 계열의 색상일 경우 컬러코드를 보고 찾아서 쓸 수 있게끔 컬러 색상과 함께 코드를 명시했음
  • Snake Case / Lower Camel Case / Upper Camel Case 사용
  • 디자이너가 정해준 컬러 이름으로 ㄱㄱ

✅strings.xml

  • 중복 생성을 방지하기 위하여 목적과 형태를 명확하게 표현
  • Snake Case 사용
[where]_[what]

✅styles.xml

  • 중복 생성을 방지하기 위하여 목적과 형태를 명확하게 표현
  • Snake Case 사용
[where]_[what]
Clone this wiki locally